poj_org 0.1.4 → 0.2.0

data/lib/poj_org/code.rb

@@ -0,0 +1,47 @@
+require 'open-uri'
+require 'cgi'
+
+# This class handles codes on poj.org
+class PojOrg::Code
+  # @return [Integer] ID of code
+  attr_accessor :id
+  
+  # @return [Integer] Author's user name
+  attr_accessor :user
+
+  # @return [Integer] Time costed in ms
+  attr_accessor :time_in_ms
+
+  # @return [Integer] Memory costed in KB
+  attr_accessor :memory_in_kb
+
+  # @return [String] Programming Language in which code is writen
+  attr_accessor :language
+
+  # @return [String] Source code
+  attr_accessor :content
+
+  # Get a code from poj.org via ID.
+  # Need to be autheticated.
+  #
+  # @param [Integer] id  ID of code
+  def initialize(id)
+    self.id = id
+    if PojOrg::authenticated?
+      cookie = PojOrg::login
+      html = open(url, 'Cookie' => cookie).read
+      self.user         = (/<td><b>User:.+?<a.+?>(.+?)<\/a><\/td>/).match(html)[1]
+      self.time_in_ms   = (/<td><b>Time:.+?(\d+)MS<\/td>/).match(html)[1].to_i
+      self.memory_in_kb = (/<td><b>Memory:.+?(\d+)K<\/td>/).match(html)[1].to_i
+      self.language     = (/<td><b>Language:<\/b>\s*(.+?)<\/td>/).match(html)[1]
+      self.content      = CGI.unescapeHTML((/<pre.+?>(.+)<\/pre>/m).match(html)[1])
+    end
+  end
+
+  # Get the url of code on poj.org
+  #
+  # @return [String] Url of code
+  def url
+    "http://poj.org/showsource?solution_id=#{id}"
+  end
+end

data/lib/poj_org/problem.rb

@@ -1,19 +1,32 @@
+# This class handles problems on poj.org
 class PojOrg::Problem
-  def self.url_for(id)
-    "http://poj.org/problem?id=#{id}"
-  end
+  # @return [Integer] ID of problem
+  attr_accessor :id
 
-  attr_accessor :id, :title, :time_limit_in_ms, :memory_limit_in_kb
+  # @return [String] Title
+  attr_accessor :title
+  
+  # @return [Integer] Time limit in ms
+  attr_accessor :time_limit_in_ms
 
-  def initialize(new_id)
-    self.id = new_id
+  # @return [Integer] Memory limit in KB
+  attr_accessor :memory_limit_in_kb
+
+  # Get a problem for poj.org via ID
+  # 
+  # @param [Integer] id  ID of problem
+  def initialize(id)
+    self.id = id
     html = open(url).read
     self.title              = html[/(?<=<div class="ptt" lang="en-US">).+?(?=<\/div>)/]
     self.time_limit_in_ms   = html[/(?<=<b>Time Limit:<\/b>)\s*\d+/].to_i
     self.memory_limit_in_kb = html[/(?<=<b>Memory Limit:<\/b>)\s*\d+/].to_i
   end
 
+  # Get the url of problem on poj.org
+  #
+  # @return [String] Url of problem
   def url
-    PojOrg::Problem.url_for id
+    "http://poj.org/problem?id=#{id}"
   end
 end

data/lib/poj_org.rb

@@ -1,10 +1,28 @@
 require 'net/http'
 
+# This class provides authetication methods
 class PojOrg
+  # Stored user name of poj.org
   @@user = nil
+
+  # Stored password of poj.org
   @@password = nil
+
+  # Status of last authentication
   @@authenticated = false
 
+  # Autheticate and store user name and password of poj.org
+  #
+  # @example
+  #   >> PojOrg::authenticate('poj_library', 'secret')
+  #   => true
+  #   >> PojOrg::authenticate('poj_library', 'wrong_password')
+  #   => false
+  #
+  # @param [String] user      user name of poj.org
+  # @param [String] password  password of poj.org
+  #
+  # @return [Boolean] whether authenticated or not
   def self.authenticate(user, password)
     if login(user, password)
       @@user = user
@@ -15,6 +33,9 @@ class PojOrg
     end
   end
 
+  # Status of last authentication
+  #
+  # @return [Boolean] Whether the last authentication success or not
   def self.authenticated?
     @@authenticated
   end
@@ -32,4 +53,4 @@ class PojOrg
 end
 
 require 'poj_org/problem'
-require 'poj_org/source'
+require 'poj_org/code'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poj_org
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies: []
-description: Fetch details of problem of source code from poj.org
+description: Fetch details of problems and codes from poj.org
 email: pinepara@gmail.com
 executables: []
 extensions: []
@@ -19,7 +19,7 @@ extra_rdoc_files: []
 files:
 - lib/poj_org.rb
 - lib/poj_org/problem.rb
-- lib/poj_org/source.rb
+- lib/poj_org/code.rb
 homepage: https://github.com/pinepara/poj_org
 licenses: []
 post_install_message: 
@@ -45,3 +45,4 @@ signing_key:
 specification_version: 3
 summary: API for poj.org
 test_files: []
+has_rdoc: 

data/lib/poj_org/source.rb

@@ -1,27 +0,0 @@
-require 'open-uri'
-require 'cgi'
-
-class PojOrg::Source
-  def self.url_for(id)
-    "http://poj.org/showsource?solution_id=#{id}"
-  end
- 
-  attr_accessor :id, :user, :time_in_ms, :memory_in_kb, :language, :source
-
-  def initialize(new_id)
-    self.id = new_id
-    if PojOrg::authenticated?
-      cookie = PojOrg::login
-      html = open(url, 'Cookie' => cookie).read
-      self.user         = (/<td><b>User:.+?<a.+?>(.+?)<\/a><\/td>/).match(html)[1]
-      self.time_in_ms   = (/<td><b>Time:.+?(\d+)MS<\/td>/).match(html)[1].to_i
-      self.memory_in_kb = (/<td><b>Memory:.+?(\d+)K<\/td>/).match(html)[1].to_i
-      self.language     = (/<td><b>Language:<\/b>\s*(.+?)<\/td>/).match(html)[1]
-      self.source       = CGI.unescapeHTML((/<pre.+?>(.+)<\/pre>/m).match(html)[1])
-    end
-  end
-
-  def url
-    PojOrg::Source.url_for id
-  end
-end