ideone-ruby-api 1.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+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 "rspec"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kenny Meyer
+
+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,23 @@
+= 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.
+
+== Usage
+
+Please, see tests.
+
+== 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
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kenny Meyer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ideone-ruby-api"
+  gem.homepage = "http://github.com/kennym/ideone-ruby-api"
+  gem.license = "MIT"
+  gem.summary = "Ruby binding for Ideone API"
+  gem.email = "knny.myer@gmail.com"
+  gem.authors = ["Kenny Meyer"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ideone-ruby-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/ideone-ruby-api.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ideone-ruby-api}
+  s.version = "1.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kenny Meyer"]
+  s.date = %q{2011-07-11}
+  s.email = %q{knny.myer@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ideone-ruby-api.gemspec",
+    "lib/ideone-ruby-api.rb",
+    "test/helper.rb",
+    "test/test_ideone-ruby-api.rb"
+  ]
+  s.homepage = %q{http://github.com/kennym/ideone-ruby-api}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Ruby binding for Ideone API}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    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<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<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<rspec>, [">= 0"])
+  end
+end
+

data/lib/ideone-ruby-api.rb

@@ -0,0 +1,156 @@
+# This program is a Ruby API to the Ideone web service. For more
+# information about the Ideone API consult
+# http://ideone.com/files/ideone-api.pdf
+#
+# Author::    Kenny Meyer  (knny.myer@gmail.com)
+# Copyright:: Copyright (c) 2011
+# License::   Distributes under the same terms as Ruby
+
+require 'savon' # SOAP Client
+
+Savon.configure do |config|
+  config.log = false            # disable logging
+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
+    
+    @client = Savon::Client.new do
+      wsdl.document = "http://ideone.com/api/1/service.wsdl"
+    end
+
+    @request_body = {
+      :user => @username,
+      :pass => @password,
+    }
+    @languages_cache = nil
+  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
+  # * 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,
+                        private=false)
+    request_body = @request_body
+    request_body[:sourceCode] = source_code
+    request_body[:language] = lang_id
+    request_body[:input] = std_input
+    request_body[:run] = run
+    request_body[:private] = private
+    response = @client.request :createSubmission, :body => @request_body
+
+    return response.to_hash[:create_submission_response][:return][:item]
+  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
+    
+    return response.to_hash[:get_submission_status][:return][:item]
+  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,
+                        with_output=true,
+                        with_stderr=true,
+                        with_cmpinfo=true)
+    request_body = @request_body
+    request_body[:withSource] = with_source
+    request_body[:withInput] = with_input
+    request_body[:withOutput] = with_output
+    request_body[:withStderr] = with_stderr
+    request_body[:withCmpinfo] = with_cmpinfo
+    response = @client.request :getSubmissionDetails, :body => request_body
+    
+    return response.to_hash[:get_submission_details][:return][:item]
+  end
+
+  # Get a list of supported languages and cache it.
+  def languages
+    if !@languages_cache
+      response = @client.request :getLanguages, :body => @request_body
+      languages = response.to_hash[:get_languages_response][:return][:item]
+      @languages_cache = languages
+      return languages
+    end
+    return @languages_cache
+  end
+  
+  # A test function that always returns the same thing.
+  def test
+    response = @client.request :testFunction, :body => @request_body
+    
+    return response.to_hash[:test_function_response][:return][:item]
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ideone-ruby-api'
+
+class Test::Unit::TestCase
+end

data/test/test_ideone-ruby-api.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+USER = 'humpydumpy'
+PASS = 'testing'
+
+class TestIdeoneRubyApi < Test::Unit::TestCase
+  def test_initialize
+    instance = Ideone.new
+    assert_not_nil(instance)
+    
+    instance = Ideone.new(USER, PASS)
+    assert_not_nil(instance)
+  end
+
+  def test_ideone_test
+    instance = Ideone.new(USER, PASS)
+
+    result = instance.test
+    assert_not_nil result
+  end
+
+  def test_languages
+    instance = Ideone.new(USER, PASS)
+
+    result = instance.languages
+
+    puts result
+    assert_not_nil result
+  end
+
+  def test_create_submission
+    instance = Ideone.new(USER, PASS)
+
+    code = "puts 'hello, world'"
+    result = instance.create_submission(code, 17)
+
+    puts result
+    assert_not_nil result
+  end
+
+  def test_submission_status
+    instance = Ideone.new(USER, PASS)
+
+    result = instance.submission_status("ZUIWF")
+    puts result
+    assert_not_nil result
+  end
+  
+  def test_submission_details
+    instance = Ideone.new(USER, PASS)
+
+    result = instance.submission_details("ZUIWF")
+    puts result
+    assert_not_nil result
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: ideone-ruby-api
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Kenny Meyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-11 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &12370800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12370800
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &12369940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12369940
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &12369080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *12369080
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &12368000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *12368000
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &12366640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12366640
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12363520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12363520
+description: 
+email: knny.myer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- ideone-ruby-api.gemspec
+- lib/ideone-ruby-api.rb
+- test/helper.rb
+- test/test_ideone-ruby-api.rb
+has_rdoc: true
+homepage: http://github.com/kennym/ideone-ruby-api
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -560738434367915780
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby binding for Ideone API
+test_files: []