ntimeline 0.1.0

data/spec/ntimeline_spec.rb

@@ -0,0 +1,293 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+include NTimeLine
+
+describe NTimeLine do
+  before(:all) do
+    @timeline =
+      TimeLine.create(:timeline_key => $timeline_key,
+                      :title => "NTimeLine TEST",
+                      :description => "This is a test for NTimeLine.",
+                      :label_for_vaxis => "dummy",
+                      :open_level => 1,
+                      :lock_level => 1,
+                      :initial_position => "last",
+                      :category => "TimeLine")
+  end
+
+  after(:all) do
+    @timeline.delete(true)
+  end
+
+  describe NTimeLine::TimeLine do
+
+    it "should be equal same id timelines" do
+      timeline = NTimeLine::TimeLine.show(@timeline.id,
+                                          {:timeline_key => $timeline_key})
+      @timeline.should == timeline
+    end
+
+    it "should have id" do
+      @timeline.id.should_not be_nil
+    end
+
+    it "should have title" do
+      @timeline.title.should == "NTimeLine TEST"
+    end
+
+    it "should have description" do
+      @timeline.description.should == "This is a test for NTimeLine."
+    end
+
+    it "should have label_for_vaxis" do
+      @timeline.label_for_vaxis.should == "dummy"
+    end
+
+    it "should have vaxis_mode" do
+      @timeline.vaxis_mode.should == "numeric"
+    end
+
+    it "should have lock_level" do
+      @timeline.lock_level.should == 1
+    end
+
+    it "should have labels" do
+      @timeline.labels.should == []
+    end
+
+    it "should have time_scale" do
+      @timeline.time_scale.should == "default"
+    end
+
+    it "should have initial_position" do
+      @timeline.initial_position.should == "last"
+    end
+
+    it "should have commentable" do
+      @timeline.commentable.should be_true
+    end
+
+    it "should have open_level" do
+      @timeline.open_level.should == 1
+    end
+
+    it "should have opend_for" do
+      @timeline.opened_for.should == []
+    end
+
+    it "should have lock_level" do
+      @timeline.lock_level.should == 1
+    end
+
+    it "should have locked_for" do
+      @timeline.locked_for.should == []
+    end
+
+    it "should have created_at" do
+      @timeline.created_at.should be_a_kind_of(Time)
+    end
+
+    it "should have updated_at" do
+      @timeline.updated_at.should be_a_kind_of(Time)
+    end
+
+    it "should have score" do
+      @timeline.score.should >= 0
+    end
+
+    it "should have point" do
+      @timeline.point.should >= 0
+    end
+
+    it "should have page_view" do
+      @timeline.page_view.should >= 0
+    end
+
+    it "should have category" do
+      @timeline.category.should == "timeline"
+    end
+
+    describe "when create" do
+      before do
+        @created = nil
+        @required = {
+          :timeline_key => $timeline_key,
+          :title => "NTimeLine test",
+          :description => "This is a test for NTimeLine library.",
+          :label_for_vaxis => "dummy"
+        }
+      end
+
+      it "should require title" do
+        @required.delete(:title)
+        Proc.new do
+          @created = NTimeLine::TimeLine.create(@required)
+        end.should raise_error(ArgumentError)
+      end
+
+      it "should require description" do
+        @required.delete(:description)
+        Proc.new do
+          @created = NTimeLine::TimeLine.create(@required)
+        end.should raise_error(ArgumentError)
+      end
+
+      it "should require label_for_vaxis" do
+        @required.delete(:label_for_vaxis)
+        Proc.new do
+          @created = NTimeLine::TimeLine.create(@required)
+        end.should raise_error(ArgumentError)
+      end
+
+      after do
+        @created.delete if @created
+      end
+    end
+
+    describe "when update" do
+      it "updated_at" do
+        old = @timeline.updated_at
+        @timeline.update({:title => "aaaa"}).updated_at.should >= old
+      end
+
+      it "can update" do
+        @timeline.update({:title => "UPDATED"}).title.should == "UPDATED"
+      end
+    end
+
+    describe "when search" do
+      it "can search by owner" do
+        pager = NTimeLine::TimeLine.search_by_owner(NTimeLine::User.me($timeline_key).nickname,
+                                                     {:timeline_key => $timeline_key})
+        pager.should be_a_kind_of(NTimeLine::TimeLinePager)
+        pager.total.should > 0
+        found = false
+        while pager do
+          if pager.timelines.include?(@timeline)
+            found = true
+            break
+          end
+          pager = pager.next
+        end
+        found.should be_true
+      end
+
+      it "can search by phrase" do
+        pager = NTimeLine::TimeLine.search_by_phrase("NTimeLine",
+                                                     {:timeline_key => $timeline_key})
+        pager.should be_a_kind_of(NTimeLine::TimeLinePager)
+        pager.total.should > 0
+        p pager
+        found = false
+        while pager do
+          if pager.timelines.include?(@timeline)
+            found = true
+            break
+          end
+          pager = pager.next
+        end
+        found.should be_true
+      end
+    end
+  end
+
+  describe NTimeLine::Article do
+    before(:all) do
+      @start_time = Time.now
+      @end_time = Time.now
+      @article =
+        @timeline.create_article(:title => "event1",
+                                 :description => "This is a test event.",
+                                 :start_time => Time.now,
+                                 :end_time => Time.now,
+                                 :grade => 10)
+    end
+
+    after(:all) do
+      @article.delete
+    end
+
+    it "can read :id" do
+      @article.id.should_not be_nil
+    end
+
+    it "can read :title" do
+      @article.title.should == "event1"
+    end
+
+    it "can read :description" do
+      @article.description.should == "This is a test event."
+    end
+
+    it "can read :start_time" do
+      @article.start_time.to_s.should == @start_time.to_s
+    end
+
+    it "can read :end_time" do
+      @article.end_time.to_s.should == @end_time.to_s
+    end
+
+    it "can read :grade" do
+      @article.grade.should == 10
+    end
+
+    it "can read :owner" do
+      @article.owner.should == NTimeLine::User.me($timeline_key).nickname
+    end
+
+    #it "can read :image" do
+    #  @article.image.should_not be_nil
+    #end
+
+    it "can read :link" do
+      @article.link.should be_a_kind_of(URI)
+    end
+
+    it "can read :related_links" do
+      @article.related_links.should be_a_kind_of(Array)
+    end
+
+    it "can read :created_at" do
+      @article.created_at.should be_a_kind_of(Time)
+    end
+
+    it "can read :updated_at" do
+      @article.updated_at.should be_a_kind_of(Time)
+    end
+
+    describe "when search" do
+      it "can search by timeline id" do
+        pager = Article.search_by_timeline_id(@timeline.id,
+                                              {:timeline_key => $timeline_key})
+        pager.should be_a_kind_of(ArticlePager)
+        pager.total.should > 0
+        found = false
+        while pager do
+          if pager.articles.include?(@article)
+            found = true
+            break
+          end
+          pager = pager.next
+        end
+        found.should be_true
+      end
+    end
+  end
+
+  describe NTimeLine::User do
+    it "should get my own information" do
+      Proc.new {
+        NTimeLine::User.me($timeline_key)
+      }.should_not raise_error(StandardError)
+    end
+
+    it "should get the user information" do
+      user = NTimeLine::User.show_by_nickname("keita.yamaguchi")
+      user.nickname.should == "keita.yamaguchi"
+      user.image.should_not be_nil
+      user.introduction.should_not be_nil
+      user.link.should_not be_nil
+      NTimeLine::User.show(user.id).nickname.should == "keita.yamaguchi"
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+-fs --colour

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$KCODE = "UTF-8"
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
+require "ntimeline"
+
+$timeline_key = File.read(File.expand_path(File.join("~", ".nifty_timeline_key")))

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html

@@ -0,0 +1,204 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      NTimeLine
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>NTimeLine</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/ntimeline"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/ntimeline" class="numbers">0.1.0</a>
+    </div>
+    <h2>What</h2>
+
+
+	<p>NTimeLine is a wrapper library for <a href="http://timeline.nifty.com/">@nifty TimeLine</a>. You can
+show/search/create/modify/delete timelines and articles.</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">ntimeline</span></pre></p>
+
+
+	<h2><span class="caps">API</span> document</h2>
+
+
+	<p>- http://ntimeline.rubyforge.org/rdoc</p>
+
+
+	<h2>The basics</h2>
+
+
+	<h3>timeline</h3>
+
+
+	<h4>show</h4>
+
+
+	<p><pre class='syntax'>
+<span class="constant">TimeLine</span><span class="punct">.</span><span class="ident">show</span><span class="punct">(</span><span class="ident">id</span><span class="punct">)</span>
+</pre></p>
+
+
+	<h4>create</h4>
+
+
+	<p><pre class='syntax'>
+<span class="constant">TimeLine</span><span class="punct">.</span><span class="ident">create</span><span class="punct">(</span><span class="symbol">:timeline_key</span> <span class="punct">=&gt;</span> <span class="global">$timeline_key</span><span class="punct">,</span>
+                <span class="symbol">:title</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">NTimeLine TEST</span><span class="punct">&quot;,</span>
+                <span class="symbol">:description</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">This is a test for NTimeLine.</span><span class="punct">&quot;,</span>
+                <span class="symbol">:label_for_vaxis</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">dummy</span><span class="punct">&quot;,</span>
+                <span class="symbol">:initial_position</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">last</span><span class="punct">&quot;,</span>
+                <span class="symbol">:category</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">TimeLine</span><span class="punct">&quot;)</span>
+</pre></p>
+
+
+	<h4>modify</h4>
+
+
+	<p><pre class='syntax'>
+<span class="ident">timeline</span><span class="punct">.</span><span class="ident">modify</span><span class="punct">(</span><span class="symbol">:title</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">modified</span><span class="punct">&quot;)</span>
+<span class="ident">timeline</span><span class="punct">.</span><span class="ident">title</span> <span class="comment"># =&gt; modified</span>
+</pre></p>
+
+
+	<h4>delete</h4>
+
+
+	<p><pre class='syntax'>
+<span class="comment"># Articles in the timeline are deleted if the argument is true.</span>
+<span class="ident">timeline</span><span class="punct">.</span><span class="ident">delete</span><span class="punct">(</span><span class="constant">true</span><span class="punct">)</span>
+</pre></p>
+
+
+	<h4>search</h4>
+
+
+	<p><pre class='syntax'>
+<span class="ident">pager</span> <span class="punct">=</span> <span class="constant">Timeline</span><span class="punct">.</span><span class="ident">search_by_owner</span><span class="punct">(&quot;</span><span class="string">keita.yamaguchi</span><span class="punct">&quot;)</span>
+<span class="ident">list</span> <span class="punct">=</span> <span class="punct">[]</span>
+<span class="keyword">while</span> <span class="ident">pager</span> <span class="keyword">do</span>
+  <span class="ident">list</span> <span class="punct">+=</span> <span class="ident">pager</span><span class="punct">.</span><span class="ident">timelines</span>
+  <span class="ident">pager</span> <span class="punct">=</span> <span class="ident">pager</span><span class="punct">.</span><span class="ident">next</span>
+<span class="keyword">end</span>
+</pre></p>
+
+
+	<h3>article</h3>
+
+
+	<h4>create</h4>
+
+
+	<p><pre class='syntax'>
+<span class="ident">timeline</span><span class="punct">.</span><span class="ident">create_article</span><span class="punct">(</span><span class="symbol">:title</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">NTimeLine test</span><span class="punct">&quot;,</span>
+                        <span class="symbol">:description</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">This is a test for NTimeLine library.</span><span class="punct">&quot;,</span>
+                        <span class="symbol">:label_for_vaxis</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">dummy</span><span class="punct">&quot;)</span>
+</pre></p>
+
+
+	<h4>modify</h4>
+
+
+	<p><pre class='syntax'>
+<span class="ident">article</span><span class="punct">.</span><span class="ident">modify</span><span class="punct">(</span><span class="symbol">:title</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">modified</span><span class="punct">&quot;)</span>
+<span class="ident">article</span><span class="punct">.</span><span class="ident">title</span> <span class="comment"># =&gt; modified</span>
+</pre></p>
+
+
+	<h4>delete</h4>
+
+
+	<p><pre class='syntax'>
+<span class="ident">article</span><span class="punct">.</span><span class="ident">delete</span>
+</pre></p>
+
+
+	<h4>search</h4>
+
+
+	<p><pre class='syntax'>
+<span class="ident">pager</span> <span class="punct">=</span> <span class="ident">article</span><span class="punct">.</span><span class="ident">search_by_timeline_id</span><span class="punct">(</span><span class="ident">timeline</span><span class="punct">.</span><span class="ident">id</span><span class="punct">)</span>
+<span class="comment"># or timeline.search_articles</span>
+<span class="ident">list</span> <span class="punct">=</span> <span class="punct">[]</span>
+<span class="keyword">while</span> <span class="ident">pager</span> <span class="keyword">do</span>
+  <span class="ident">list</span> <span class="punct">+=</span> <span class="ident">pager</span><span class="punct">.</span><span class="ident">articles</span>
+  <span class="ident">pager</span> <span class="punct">=</span> <span class="ident">pager</span><span class="punct">.</span><span class="ident">next</span>
+<span class="keyword">end</span>
+</pre></p>
+
+
+	<h2>Forum</h2>
+
+
+	<p><a href="http://groups.google.com/group/ntimeline">http://groups.google.com/group/ntimeline</a></p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+
+
+	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/ntimeline/trunk</code> for anonymous access.</p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the Ruby license.</p>
+
+
+	<h2>Links</h2>
+
+
+	<p>- <a href="http://www.nifty.com/">@nifty</a>
+&#8212;<a href="http://timeline.nifty.com/">@nifty TimeLine</a>
+&#8212;<a href="http://webservice.nifty.com/timeline/">@nifty Web Service / TimeLine</a>
+- NTimeLine
+&#8212;<a href="http://ntimeline.rubyforge.org/">Website</a>
+&#8212;<a href="http://rubyforge.org/projects/ntimeline/">Rubyforge Project</a></p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send an email to <a href="mailto:keita.yamaguchi@gmail.com">Keita Yamaguchi</a> or the <a href="http://groups.google.com/group/ntimeline">forum</a></p>
+    <p class="coda">
+      <a href="keita.yamaguchi@gmail.com">Keita Yamaguchi</a>, 30th December 2007<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>