nickel 0.0.2

data/History.txt

@@ -0,0 +1,7 @@
+== 0.0.1 2009-03-22
+
+Initial release!
+
+== 0.0.2 2009-03-30
+
+No www in request

data/License.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Louis Zell <lzell11@gmail.com>
+
+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,51 @@
+=== Nickel is a client for Natural Inputs
+=== Install
+  
+  gem install lzell-nickel
+
+=== Usage
+
+==== A single occurrence
+  n = Nickel.query "lunch tomorrow with maria"
+  n.message                       # => lunch with maria
+  n.occurrences[0].type           # => single
+  n.occurrences[0].start_date     # => 20090323
+
+==== A daily occurrence
+  n = Nickel.query "wake up everyday at 11am"
+  n.message                       # => wake up
+  n.occurrences[0].type           # => daily
+  n.occurrences[0].start_time     # => 11:00:00
+  
+==== A weekly occurrence
+  n = Nickel.query "guitar lessons every tuesday at 5pm"
+  n.message                       # => guitar lessons
+  n.occurrences[0].type           # => weekly
+  n.occurrences[0].day_of_week    # => tue
+  n.occurrences[0].interval       # => 1
+  n.occurrences[0].start_time     # => 17:00:00
+
+==== A day monthly occurrence
+  n = Nickel.query "drink specials on the second thursday of every month"
+  n.message                       # => drink specials
+  n.occurrences[0].type           # => daymonthly
+  n.occurrences[0].day_of_week    # => thu
+  n.occurrences[0].week_of_month  # => 2
+  n.occurrences[0].interval       # => 1
+  
+==== A date monthly occurrence
+  n = Nickel.query "pay credit card every month on the 22nd"
+  n.message                       # => pay credit card
+  n.occurrences[0].type           # => datemonthly
+  n.occurrences[0].date_of_month  # => 22
+  n.occurrences[0].interval       # => 1
+
+==== Multiple occurrences
+  n = Nickel.query "band meeting every monday and wednesday at 2pm"
+  n.message                       # => band meeting
+  n.occurrences[0].type           # => weekly
+  n.occurrences[0].day_of_week    # => mon
+  n.occurrences[0].start_time     # => 14:00:00
+  n.occurrences[1].type           # => weekly
+  n.occurrences[1].day_of_week    # => wed
+  n.occurrences[1].start_time     # => 14:00:00

data/lib/nickel.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'mapricot'
+
+module Nickel
+  VERSION = "0.0.2"
+
+  def self.query(q)
+    date_time = Time.now.strftime("%Y%m%dT%H%M%S")
+    url = "http://naturalinputs.com/query?q=#{URI.escape(q)}&t=#{date_time}"
+    Mapricot.parser = :libxml
+    Api::NaturalInputsResponse.new(:url => url)
+  end
+end
+
+
+module Nickel
+  module Api
+    class NaturalInputsResponse < Mapricot::Base
+      has_one   :message
+      has_many  :occurrences, :xml
+    end
+
+    class Occurrence < Mapricot::Base
+      has_one   :type
+      has_one   :start_date
+      has_one   :end_date
+      has_one   :start_time
+      has_one   :end_time
+      has_one   :day_of_week
+      has_one   :week_of_month,   :integer
+      has_one   :date_of_month,   :integer
+      has_one   :interval,        :integer
+    end
+  end
+end

data/nickel.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name     = "nickel"
+  s.version  = "0.0.2"
+  s.summary  = "Natural language date and time parsing"
+  s.email    = "lzell11@gmail.com"
+  s.homepage = "http://github.com/lzell/nickel"
+	s.description = "A client for naturalinputs.com.  Extracts date, time, and message information from naturally worded text."
+  s.has_rdoc = true
+  s.authors  = ["Lou Zell"]
+  s.files    = ["README.rdoc", 
+      "History.txt",
+      "License.txt",
+      "nickel.gemspec",
+      "test/nickel_spec.rb",
+      "lib/nickel.rb"]
+  s.require_paths = ["lib"]
+  s.rdoc_options = ["--main", "README.rdoc", "--title", "Nickel"]
+  s.extra_rdoc_files = ["README.rdoc"]
+  s.add_dependency("mapricot")
+end

data/test/nickel_spec.rb

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'spec'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/nickel")
+
+
+describe "A single date" do 
+  before(:all) { @n = Nickel.query "oct 15 09" }
+  
+  it "should have an empty message" do 
+    @n.message.should be_empty
+  end
+  
+  it "should have a start date" do 
+    @n.occurrences.size.should == 1
+    @n.occurrences.first.start_date.should == "20091015"
+  end
+end
+
+describe "A daily occurrence" do 
+  before(:all) do 
+    @n = Nickel.query "wake up everyday at 11am"
+    @occurs = @n.occurrences.first
+  end
+  
+  it "should have a message" do 
+    @n.message.should == "wake up"
+  end
+  
+  it "should be daily" do
+    @occurs.type.should == "daily"
+  end
+  
+  it "should have a start time" do 
+    @occurs.start_time.should == "11:00:00"
+  end
+end
+
+
+describe "A weekly occurrence" do
+  before(:all) do 
+    @n = Nickel.query "guitar lessons every tuesday at 5pm"
+    @occurs = @n.occurrences.first
+  end
+  
+  it "should have a message" do
+    @n.message.should == "guitar lessons"
+  end
+  
+  it "should be weekly" do 
+    @occurs.type.should == "weekly"
+  end
+  
+  
+  it "should occur on tuesdays" do
+    @occurs.day_of_week.should == "tue"
+  end
+  
+  it "should occur once per week" do 
+    @occurs.interval.should == 1
+  end
+  
+  it "should start at 5pm" do 
+    @occurs.start_time.should == "17:00:00"
+  end
+  
+  it "should have a start date" do 
+    @occurs.start_date.should_not be_nil
+  end
+  
+  it "should not have an end date" do 
+    @occurs.end_date.should be_nil
+  end
+end
+
+
+describe "A day monthly occurrence" do 
+  before(:all) do 
+    @n = Nickel.query "drink specials on the second thursday of every month"
+    @occurs = @n.occurrences.first
+  end
+  
+  it "should have a message" do 
+    @n.message.should == "drink specials"
+  end
+  
+  it "should be day monthly" do 
+    @occurs.type.should == "daymonthly"
+  end
+  
+  it "should occur on second thursday of every month" do 
+    @occurs.week_of_month.should == 2
+    @occurs.day_of_week.should == "thu"
+  end
+  
+  it "should occur once per month" do 
+    @occurs.interval.should == 1
+  end
+end
+
+
+
+describe "A date monthly occurrence" do 
+  before(:all) do 
+    @n = Nickel.query "pay credit card every month on the 22nd"
+    @occurs = @n.occurrences.first
+  end
+  
+  it "should have a message" do 
+    @n.message.should == "pay credit card"
+  end
+  
+  it "should be date monthly" do 
+    @occurs.type.should == "datemonthly"
+  end
+  
+  it "should occur on the 22nd of every month" do
+    @occurs.date_of_month.should == 22
+  end
+  
+  it "should occur once per month" do 
+    @occurs.interval.should == 1
+  end
+end
+
+
+describe "Multiple occurrences" do 
+  before(:all) do 
+    @n = Nickel.query "band meeting every monday and wednesday at 2pm"
+  end
+  
+  it "should have a message" do 
+    @n.message.should == "band meeting"
+  end
+  
+  it "should have two occurrences" do 
+    @n.occurrences.size.should == 2
+  end
+  
+  it "should occur on mondays and wednesdays" do 
+    days = @n.occurrences.collect {|occ| occ.day_of_week}
+    days.include?("mon").should be_true
+    days.include?("wed").should be_true
+    days.size.should == 2
+  end
+  
+  it "should occur at 2pm on both days" do 
+    @n.occurrences[0].start_time.should == "14:00:00"
+    @n.occurrences[1].start_time.should == "14:00:00"
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: nickel
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Lou Zell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-31 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mapricot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: A client for naturalinputs.com.  Extracts date, time, and message information from naturally worded text.
+email: lzell11@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- History.txt
+- License.txt
+- nickel.gemspec
+- test/nickel_spec.rb
+- lib/nickel.rb
+has_rdoc: true
+homepage: http://github.com/lzell/nickel
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- Nickel
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Natural language date and time parsing
+test_files: []
+