ntimeline 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.1.0 2007-12-30
+
+* Keita Yamaguchi:
+  * Initial release

data/License.txt

@@ -0,0 +1,3 @@
+Copyright (c) 2007 Keita Yamaguchi
+
+NTimeLine is released under the Ruby license.

data/Manifest.txt

@@ -0,0 +1,31 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/ntimeline.rb
+lib/ntimeline/article.rb
+lib/ntimeline/category.rb
+lib/ntimeline/pager.rb
+lib/ntimeline/timeline.rb
+lib/ntimeline/user.rb
+lib/ntimeline/version.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/ntimeline_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,19 @@
+= README
+
+Authors::   Keita Yamaguchi(山口慶太)
+Copyright:: Copyright (C) Keita Yamaguchi, 2007. All rights reserved.
+License::   Ruby License
+
+== What
+
+NTimeLine is a wrapper library for @nifty TimeLine. You can
+show/search/create/modify/delete timelines and articles.
+
+== Links
+
+* {@nifty}[http://www.nifty.com/]
+  * {@nifty TimeLine}[http://timeline.nifty.com/]
+  * {@nifty Web Service / TimeLine}[http://webservice.nifty.com/timeline/]
+* NTimeLine
+  * {Website}[http://ntimeline.rubyforge.org/]
+  * {Rubyforge Project}[http://rubyforge.org/projects/ntimeline/]

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,83 @@
+require 'ntimeline/version'
+
+AUTHOR = 'Keita Yamaguchi'  # can also be an array of Authors
+EMAIL = "keita.yamaguchi@gmail.com"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'ntimeline' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'ntimeline' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = NTimeLine::VERSION::STRING + (REV ? ".#{REV}" : "")
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+
+end
+
+Rake::RDocTask.new(:docs) do |rd|
+  rd.main = "README.txt"
+  rd.rdoc_dir = "doc"
+  Dir.glob("lib/**/*.rb") do |path| rd.rdoc_files << path end
+  rd.rdoc_files += ["README.txt", "History.txt", "License.txt"]
+  rd.title = GEM_NAME + " documentation"
+  rd.options += ["--opname", "index.html",
+                 "--line-numbers",
+                 "--inline-source",
+                 "--accessor", "text_data=R",
+                 "--accessor", "bool_data=R",
+                 "--accessor", "time_data=R",
+                 "--accessor", "int_data=R",
+                 "--accessor", "url_data=R",
+                 "--charset", "UTF-8"]
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'ntimeline'

data/lib/ntimeline.rb

@@ -0,0 +1,172 @@
+require "net/http"
+require "uri"
+require "rexml/document"
+require "time"
+
+module NTimeLine
+  URL = URI.parse("http://api.timeline.nifty.com/api/v1")
+
+  class Base
+    attr_accessor :timeline_key, :updated
+
+    #
+    # setters
+    #
+
+    def self.text_data(*args)
+      @text_data ? @text_data += args : @text_data = args
+      attr_reader *args
+    end
+
+    def self.int_data(*args)
+      @int_data ? @int_data += args : @int_data = args
+      attr_reader *args
+    end
+
+    def self.bool_data(*args)
+      @bool_data ? @bool_data += args : @bool_data = args
+      attr_reader *args
+    end
+
+    def self.time_data(*args)
+      @time_data ? @time_data += args : @time_data = args
+      attr_reader *args
+    end
+
+    def self.url_data(*args)
+      @url_data ? @url_data += args : @url_data = args
+      attr_reader *args
+    end
+
+    #
+    # methods
+    #
+
+    def initialize(res) #:nodoc:
+      init(res)
+    end
+
+    def refresh(res) #:nodoc:
+      init(res)
+      return self
+    end
+
+    def init(res) #:nodoc:
+      self.class.instance_eval{@text_data||[]}.each do |data|
+        if res.elements[data.to_s]
+          instance_variable_set("@"+data.to_s, res.elements[data.to_s].text)
+        end
+      end
+      self.class.instance_eval{@int_data||[]}.each do |data|
+        if res.elements[data.to_s]
+          instance_variable_set("@"+data.to_s, res.elements[data.to_s].text.to_i)
+        end
+      end
+      self.class.instance_eval{@bool_data||[]}.each do |data|
+        if res.elements[data.to_s]
+          instance_variable_set("@"+data.to_s,
+                                (res.elements[data.to_s].text == "true"))
+        end
+      end
+      self.class.instance_eval{@time_data||[]}.each do |data|
+        if res.elements[data.to_s]
+          instance_variable_set("@"+data.to_s,
+                                Time.parse(res.elements[data.to_s].text))
+        end
+      end
+      self.class.instance_eval{@url_data||[]}.each do |data|
+        if res.elements[data.to_s].text
+          instance_variable_set("@"+data.to_s,
+                                URI.parse(res.elements[data.to_s].text))
+        end
+      end
+    end
+
+    # Send a request message to the server.
+    # path:: relative path from http://api.timeline.nifty.com/api/v1
+    # params:: parameters hash table
+    # target:: class or object
+    def self.request(path, params={}, target = self)
+      req = Net::HTTP::Post.new(URL.path + path)
+      data = params.inject(Hash.new) do |data, (key, val)|
+        val.kind_of?(Time) ? data[key.to_s] = val.iso8601 : data[key.to_s] = val
+        data
+      end
+      req.set_form_data data
+      case res = Net::HTTP.new(URL.host).request(req)
+      when Net::HTTPSuccess
+        doc = REXML::Document.new(res.body)
+        obj = target.kind_of?(Class) ? target.new(doc) : target.refresh(doc)
+        obj.request_params = params if obj.kind_of?(NTimeLine::Pager)
+        obj.timeline_key = params[:timeline_key] if params.has_key?(:timeline_key)
+        return obj
+      when Net::HTTPBadRequest
+        raise BadRequestError.new(REXML::Document.new(res.body))
+      when Net::HTTPForbidden
+        p res.body
+        raise ForbiddenError.new(REXML::Document.new(res.body))
+      else
+        raise ResponseError.new(res)
+      end
+    end
+
+    # Same as request but need timeline_key.
+    # path:: relative path from http://api.timeline.nifty.com/api/v1
+    # params:: parameters hash table
+    # target:: class or object
+    def self.request_with_key(path, params={}, target=self)
+      # check timeline_key
+      unless params.has_key?(:timeline_key)
+        raise ArgumentError, "There is not :timeline_key in params"
+      end
+      # request
+      request(path, params, target)
+    end
+
+    # Same as request.
+    def request(path, params={}, target = self.class)
+      self.class.request(path, params, target)
+    end
+
+    # Same as request_with_key.
+    def request_with_key(path, params={}, target = self.class)
+      self.class.request_with_key(path, params, target)
+    end
+  end
+
+  # Succeeded is a dummy class for successful response.
+  class Succeeded < Base
+    def initialize(doc); end
+  end
+
+  #
+  # EXCEPTIONS
+  #
+
+  class Error < StandardError; end
+
+  class ResponseError < Error
+    attr_reader :response
+    def initialize(response)
+      @response = response
+    end
+  end
+
+  class BadRequestError < Error
+    def initialize(res)
+      @response = res
+      @code = res.elements["/response/status/code"].text.to_i
+      @message = res.elements["/response/status/message"].text
+    end
+
+    def message
+      self.class.name + "(code:" + @code.to_s + "): message=" + @message
+    end
+  end
+end
+
+require 'ntimeline/article'
+require 'ntimeline/timeline'
+require 'ntimeline/pager'
+require 'ntimeline/user'
+require 'ntimeline/version'

data/lib/ntimeline/article.rb

@@ -0,0 +1,146 @@
+module NTimeLine
+
+  # Ariticle is a class for an event article.
+  class Article < Base
+    text_data :id, :title, :description, :owner
+    int_data :grade
+    time_data :start_time, :end_time, :updated_at, :created_at
+    url_data :image, :link
+    attr_reader :related_links
+
+    def init(doc) #:nodoc:
+      elt = nil
+      if doc.kind_of?(REXML::Document)
+        unless elt = doc.root.elements["/response/result/article"]
+          raise ArgumentError, doc
+        end
+      else
+        elt = doc
+      end
+      super(elt)
+      @related_links = []
+      elt.elements["related_links"].each_element("url") do |url|
+        @related_links << url.text
+      end
+    end
+
+    def ==(other) #:nodoc:
+      @id == other.id
+    end
+
+    # Fetch an article by id.
+    # id:: article id
+    # params:: See http://webservice.nifty.com/timeline/v1/articles/show.htm for details.
+    # - :timeline_key
+    def self.show(id, params={})
+      # check timeline_key
+      unless params.has_key?(:timeline_key)
+        raise ArgumentError, "There is not :timeline_key in params."
+      end
+      # send
+      request("/articles/show/#{id}", params)
+    end
+
+    # Create a new article.
+    # params:: See http://webservice.nifty.com/timeline/v1/articles/create.htm for details.
+    # - :timeline_key (required)
+    # - :timeline_id (required)
+    # - :title (required)
+    # - :description (required)
+    # - :start_time (required)
+    # - :end_time (required)
+    # - :grade (required)
+    # - :link (FIXME: URI or array of it)
+    # - :image (FIXME: file or string)
+    # - :image_type
+    def self.create(params)
+      # check params
+      unless params.include?(:timeline_id) &&
+          params.include?(:title)          &&
+          params.include?(:description)    &&
+          params.include?(:start_time)     &&
+          params.include?(:end_time)       &&
+          params.include?(:grade)
+        raise ArgumentError, <<-ERR
+Required parameters(:title, :description, :start_time, :end_time, :grade) are missing.
+        ERR
+      end
+
+      # request
+      request_with_key("/articles/create", params)
+    end
+
+    # Update an article.
+    # id:: article id
+    # params:: see http://webservice.nifty.com/timeline/v1/articles/create.htm for details
+    # - :title
+    # - :description
+    # - :start_time
+    # - :end_time
+    # - :grade
+    # - :link
+    # - :image
+    # - :image_type
+    def self.update(id, params, target=self)
+      request_with_key("/articles/update/#{id}", params, target)
+    end
+
+    # Update the article.
+    # params:: same as update
+    def update(params)
+      self.class.update(@id, params, self)
+    end
+
+    # Search articles.
+    # params:: see http://webservice.nifty.com/timeline/v1/articles/search.htm.
+    # - :timeline_key
+    # - :timeline_id
+    # - :phrase
+    # - :time_spec
+    # - :start_time
+    # - :end_time
+    # - :page
+    # - :hits
+    # - :order
+    # - :has_image
+    def self.search(params)
+      request("/articles/search", params, ArticlePager)
+    end
+
+    # Search articles by timeline id.
+    # timeline_id:: timeline id
+    def self.search_by_timeline_id(timeline_id, params={})
+      search(params.merge(:timeline_id => timeline_id))
+    end
+
+    # Search articles by phrase.
+    # phrase:: query words
+    # params:: same as search
+    def self.search_by_phrase(phrase, params={})
+      search(params.merge(:phrase => phrase))
+    end
+
+    # Search articles by time_spec.
+    # params:: same as search
+    def self.search_by_time_spec(time_spec, params={})
+      unless params.has_key?(:start_time) and params.has_key?(:end_time)
+        raise ArgumentError, "There is not :start_time and/or :end_time in params."
+      end
+      search(params.merge(:time_spec => time_spec))
+    end
+
+    # Delete an article.
+    # id:: article id
+    # timeline_key:: timeline API key
+    def self.delete(id, timeline_key)
+      request_with_key("/articles/delete/#{id}",
+                       {:timeline_key => timeline_key},
+                       Succeeded)
+    end
+
+    # Delete the article.
+    def delete
+      self.class.delete(@id, @timeline_key)
+    end
+  end
+end