ideone-ruby-api 1.2.0 → 1.3.0

data/Gemfile

@@ -7,10 +7,8 @@ gem 'savon'
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
   gem "test-unit", "~> 2.3"
-  gem "rspec"
 end

data/README.rdoc

@@ -1,32 +1,58 @@
 = ideone-ruby-api
 
-Ideone is a pastebin, as well as an online compiler and debugger. This project is a Ruby binding to the Ideone API.
+Ideone is a pastebin, as well as an online compiler and debugger. This
+project is a Ruby binding to the Ideone API.
 
 == Usage
 
    require 'ideone'
 
    # Authenticate with Ideone
-   i = Ideone('username', 'password')
-
+   i = Ideone.new('username', 'password')
+   => #<Ideone:0x000000021dfd88 ... >
+  
    # Create submission
    source_code = "puts 'hello, world'"
    i.create_submission(source_code,
                        17) # Ruby
+   => 'TOKEN'
 
    # Get submission status
-   i.submission_status("XXXXX")
+   i.submission_status("TOKEN")
+   => {:status=>0, :result=>15}
 
    # Get all available languages
-   i.languages()
+   i.languages
+   => [{:key=>"7", :value=>"Ada (gnat-4.3.2)"},
+       {:key=>"13", :value=>"Assembler (nasm-2.07)"},
+       ...
+       {:key=>"104", :value=>"AWK (gawk) (gawk-3.1.6)"},
+       {:key=>"6", :value=>"Whitespace (wspace 0.3)"}]
+
+   # Test that everything's working
+   i.test
+   => {"error"=>"OK",
+       "moreHelp"=>"ideone.com",
+       "pi"=>"3.14",
+       "answerToLifeAndEverything"=>"42",
+       "oOok"=>true} 
+
+== Similar projects
 
-   # Test
-   i.test()   
+ - https://github.com/maveonair/ccpacona
+ - https://github.com/jonathanperret/ideone.rb
+ - https://github.com/Pistos/ideone-gem/blob/master/lib/ideone.rb
 
-== Running test suite
+I stole the best ideas from each of the above projects, which, I
+think, makes it much more robust, and it includes tests (which
+actually pass).
+
+== Running the test suite
 
 To run the test suite, please fill out USER and PASS in test/test_ideone-ruby-api.rb
 
+Then, you can run `rake test`
+
 == Contributing to ideone-ruby-api
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/ideone-ruby-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ideone-ruby-api}
-  s.version = "1.2.0"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kenny Meyer"]
-  s.date = %q{2011-07-12}
+  s.date = %q{2011-08-01}
   s.description = %q{A better Ruby binding for the Ideone API }
   s.email = %q{knny.myer@gmail.com}
   s.extra_rdoc_files = [
@@ -39,29 +39,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<savon>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<test-unit>, ["~> 2.3"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<savon>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<test-unit>, ["~> 2.3"])
-      s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<savon>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<test-unit>, ["~> 2.3"])
-    s.add_dependency(%q<rspec>, [">= 0"])
   end
 end
 

data/lib/ideone.rb

@@ -7,21 +7,10 @@
 # License::   Distributes under the same terms as Ruby
 
 require 'savon' # SOAP Client
-require 'logger'
 require 'pp'
 
-Savon.configure do |config|
-  config.log = false # TODO: Make this a setting
-end
-
-
 class Ideone
 
-  # Keyword arguments
-  # -----------------
-  #
-  # * username: a valid Ideone username
-  # * password: a valid Ideone password
   def initialize(username=nil, password=nil)
     @username = username
     @password = password
@@ -30,35 +19,16 @@ class Ideone
       wsdl.document = "http://ideone.com/api/1/service.wsdl"
     end
 
+    HTTPI.log = false
+    disable_savon_logging()
+    
     @request_body = {
       :user => @username,
       :pass => @password,
     }
     @languages_cache = nil
-    # Set up logger
-    @log = Logger.new(STDOUT)
-    @log.level = Logger::WARN
-
   end
 
-  # Create a submission and upload it to Ideone.
-  #
-  # Keyword Arguments
-  # -----------------
-  #  
-  # * source_code: a string of the program's source code
-  # * lang_id: the ID of the programming language.
-  # * std_input: the string to pass to the program on stdin
-  # * run: a boolean flag to signifying if Ideone should compile and
-  #        run the program
-  # * is_private: a boolean flag to toggle visibility of code to others
-  # 
-  # Returns
-  # -------
-  # 
-  # A hash with the keys error and link.  The link is the
-  # unique id of the program.  The URL of the submission is
-  # http://ideone.com/LINK.
   def create_submission(source_code, lang_id, std_input="", run=true,
                         is_private=false)
     request_body = @request_body
@@ -69,62 +39,27 @@ class Ideone
     request_body[:private] = is_private
     response = @client.request :createSubmission, :body => @request_body
 
-    return pp response.to_hash[:create_submission_response][:return][:item]
+    check_error(response, :create_submission_response)
+    return response.to_hash[:create_submission_response][:return][:item][1][:value]
   end
 
-  # Given the unique link of a submission, returns its current status.
-  #  
-  # Keyword Arguments
-  # -----------------
-  # 
-  # * link: the unique id string of a submission
-  # 
-  # Returns
-  # -------
-  # 
-  # A hash of the error, the result code and the status code.
-  # 
-  # Notes
-  # -----
-  # 
-  # Status specifies the stage of execution.
-  # 
-  # * status < 0 means the program awaits compilation
-  # * status == 0 means the program is done
-  # * status == 1 means the program is being compiled
-  # * status == 3 means the program is running
-  # 
-  # Result specifies how the program finished.
-  # 
-  # * result == 0 means not running, the program was submitted
-  #               with run=False
-  # * result == 11 means compilation error
-  # * result == 12 means runtime error
-  # * result == 13 means timelimit exceeded
-  # * result == 15 means success
-  # * result == 17 means memory limit exceeded
-  # * result == 19 means illegal system call
-  # * result == 20 means Ideone internal error, submit a bug report
   def submission_status(link)
     request_body = @request_body
     request_body[:link] = link
     response = @client.request :getSubmissionStatus, :body => request_body
+
+    check_error(response, :get_submission_status_response)
+
+    status = response.to_hash[:get_submission_status_response][:return][:item][1][:value].to_i
+    result = response.to_hash[:get_submission_status_response][:return][:item][2][:value].to_i
     
-    return pp response.to_hash[:get_submission_status_response][:return][:item]
+    if status < 0
+      status = -1
+    end
+
+    return { :status => status, :result => result }
   end
 
-  # Return a hash of requested details about a submission with the id
-  # of link.
-  #
-  # Keyword Arguments
-  # -----------------
-  #
-  # * link: the unique string ID of a submission
-  # * with_source: should we request the source code
-  # * with_input: request the program input
-  # * with_output: request the program output
-  # * with_stderr: request the error output
-  # * with_cmpinfo: request compilation flags
   def submission_details(link,
                          with_source=true,
                          with_input=true,
@@ -138,30 +73,72 @@ class Ideone
     request_body[:withOutput] = with_output
     request_body[:withStderr] = with_stderr
     request_body[:withCmpinfo] = with_cmpinfo
-    begin
-      response = @client.request :getSubmissionDetails, :body => request_body
-    rescue Savon::SOAP::Fault => fault
-      @log.warn fault.to_s
-      raise fault
-    end
+
+    response = @client.request :getSubmissionDetails, :body => request_body
+    
+    check_error(response, :get_submission_details_response)
+
+    details = response.to_hash[:get_submission_details_response][:return][:item]
     
-    return pp response.to_hash[:get_submission_details_response][:return][:item]
+    create_dict(details)
   end
 
   # Get a list of supported languages and cache it.
   def languages
-    if !@languages_cache
+    unless @languages_cache
       response = @client.request :getLanguages, :body => @request_body
-      languages = response.to_hash[:get_languages_response][:return][:item]
+
+      check_error(response, :get_languages_response)
+      
+      languages = response.to_hash[:get_languages_response][:return][:item][1][:value][:item]
       @languages_cache = languages
     end
-    return pp @languages_cache
+    return @languages_cache
   end
   
   # A test function that always returns the same thing.
   def test
     response = @client.request :testFunction, :body => @request_body
+
+    check_error(response, :test_function_response)
+
+    items = response.to_hash[:test_function_response][:return][:item]
+    create_dict(items)
+  end
+
+  private
+
+  def disable_savon_logging
+    Savon.configure do |config|
+      config.log = false
+    end
+  end
+  
+  def check_error(response, function_response)
+    error = get_error(response.to_hash, function_response)
+    if error != 'OK'
+      raise error
+    end
+  end
+  
+  def get_error(response, function_response)
+    begin
+     return response[function_response][:return][:item][0][:value]
+    rescue
+      return response[function_response][:return][:item][:value]
+    end
+  end
+  
+  def create_dict(items)
+    dict = {}
+    
+    items.each do |item|
+      key = item[:key]
+      value = item[:value]
+      dict[key] = value
+    end
     
-    return pp response.to_hash[:test_function_response][:return][:item]
+   dict
   end
+  
 end

data/test/test_ideone-ruby-api.rb

@@ -20,7 +20,12 @@ class TestIdeoneRubyApi < Test::Unit::TestCase
     instance = Ideone.new(USER, PASS)
 
     result = instance.test
-    puts result
+
+    def compare_intersecting_keys(a, b)
+      (a.keys & b.keys).all? {|k| a[k] == b[k]}
+    end
+
+    assert compare_intersecting_keys(result,{"error"=>"OK", "moreHelp"=>"ideone.com", "pi"=>"3.14", "answerToLifeAndEverything"=>"42", "oOok"=>true}) == true
     assert_not_nil result
   end
 
@@ -31,7 +36,7 @@ class TestIdeoneRubyApi < Test::Unit::TestCase
 
     result = instance.languages
 
-    puts result
+    assert result.count > 10
     assert_not_nil result
   end
 
@@ -45,7 +50,7 @@ puts "This is a test submission created from ideone-ruby-api. https://github.com
     eos
     result = instance.create_submission(code, 17)
 
-    puts result
+    assert result.is_a?(String)
     assert_not_nil result
   end
 
@@ -54,9 +59,11 @@ puts "This is a test submission created from ideone-ruby-api. https://github.com
     
     instance = Ideone.new(USER, PASS)
 
-    result = instance.submission_status("VWMD7")
-    puts result
+    result = instance.submission_status("nDRJO")
+
     assert_not_nil result
+    assert_not_nil result[:status]
+    assert_not_nil result[:result]
   end
   
   def test_submission_details
@@ -64,8 +71,9 @@ puts "This is a test submission created from ideone-ruby-api. https://github.com
     
     instance = Ideone.new(USER, PASS)
 
-    result = instance.submission_details("ZUIWF")
-    puts result
+    result = instance.submission_details("nDRJO")
+
+    assert result.count == 16
     assert_not_nil result
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ideone-ruby-api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-12 00:00:00.000000000 -04:00
+date: 2011-08-01 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &11568680 !ruby/object:Gem::Requirement
+  requirement: &16794180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,21 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11568680
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &11567980 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *11567980
+  version_requirements: *16794180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &11567300 !ruby/object:Gem::Requirement
+  requirement: &16792980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *11567300
+  version_requirements: *16792980
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &11566360 !ruby/object:Gem::Requirement
+  requirement: &16791600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +44,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *11566360
+  version_requirements: *16791600
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &11565680 !ruby/object:Gem::Requirement
+  requirement: &16790440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11565680
+  version_requirements: *16790440
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &11565180 !ruby/object:Gem::Requirement
+  requirement: &16789640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,18 +66,7 @@ dependencies:
         version: '2.3'
   type: :development
   prerelease: false
-  version_requirements: *11565180
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &11562600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *11562600
+  version_requirements: *16789640
 description: ! 'A better Ruby binding for the Ideone API '
 email: knny.myer@gmail.com
 executables: []
@@ -123,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4538202430924813722
+      hash: 1053003594121317126
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: