ideone-ruby-api 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 001863875eed57b773be63c9ae772bf42d80c791
-  data.tar.gz: 530757e8307000be2aa9b2616efe98c26b397705
+  metadata.gz: a80d2e7351262112663d0229b3829a8711c7a1c9
+  data.tar.gz: f5c79917c54b81fff26c52c21a2aa00d114d4f88
 SHA512:
-  metadata.gz: aa32c8b38d83f5e3c07b3d45caeae5523e29a83b55896aff9e0e9a320d7809d1c97c6f0a11763a59e72edad81bb91ccb50370aa9f457b1baedd01129b3bb1d66
-  data.tar.gz: 0e48ce9bd2a067f7873a7e6d5be8b5bef087a99f0c387d8175cedbe3455fea721f3b6ce35dfb49c413f987637a57ccbdc16198fd90625fa331c0c2f04dff3737
+  metadata.gz: 8562a4d8112ef8b9b57fcce6d14c79e852258b85bf719d10291cbe7e8d6a60a4eabe9ab9442882c9bf5f56cd79936c94a22c5a167a579994caae02305aa856ad
+  data.tar.gz: 071fc2046c3f074599d2ee6eb63eaf32f35b57941aafeccaaf09fe38aa5b01bf9957c5b77cbd26310e65a95def1f0fdffaca29ecd99cdef31919a9649f3344dc

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0

data/README.rdoc

@@ -1,10 +1,14 @@
 = ideone-ruby-api
 
 {<img src="https://secure.travis-ci.org/kennym/ideone-ruby-api.png" />}[http://travis-ci.org/kennym/ideone-ruby-api]
+{<img src="https://badge.fury.io/rb/ideone-ruby-api.png" alt="Gem Version" />}[http://badge.fury.io/rb/ideone-ruby-api]
+{<img src="https://ga-beacon.appspot.com/UA-48308186-1/ideone-ruby-api/README.rdoc" alt="GA analytics" />}[https://ga-beacon.appspot.com/UA-48308186-1/ideone-ruby-api/README.rdoc]
 
 Ideone is a pastebin, as well as an online compiler and debugger. This
 project is a Ruby binding to the Ideone API.
 
+Requires Ruby =>1.9.2
+
 == Usage
 
    require 'ideone'
@@ -12,7 +16,11 @@ project is a Ruby binding to the Ideone API.
    # Authenticate with Ideone
    i = Ideone.new('username', 'password')
    => #<Ideone:0x000000021dfd88 ... >
-  
+
+   # Enable logging by setting flag to `true`
+   i = Ideone.new('username', 'password', true)
+   => #<Ideone:0x000000021dfd88 ... >
+
    # Create submission
    source_code = "puts 'hello, world'"
    i.create_submission(source_code,
@@ -34,7 +42,7 @@ project is a Ruby binding to the Ideone API.
        "moreHelp"=>"ideone.com",
        "pi"=>"3.14",
        "answerToLifeAndEverything"=>"42",
-       "oOok"=>true} 
+       "oOok"=>true}
 
 == Similar projects
 

data/ideone-ruby-api.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: ideone-ruby-api 2.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ideone-ruby-api"
-  s.version = "2.0.0"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Kenny Meyer"]
-  s.date = "2014-02-20"
+  s.date = "2014-05-10"
   s.description = "A better Ruby binding for the Ideone API "
   s.email = "kenny@kennymeyer.net"
   s.extra_rdoc_files = [
@@ -26,14 +28,14 @@ Gem::Specification.new do |s|
     "VERSION",
     "ideone-ruby-api.gemspec",
     "lib/ideone.rb",
+    "lib/ideone/exceptions.rb",
     "lib/ideone/version.rb",
     "test/helper.rb",
     "test/test_ideone-ruby-api.rb"
   ]
   s.homepage = "http://github.com/kennym/ideone-ruby-api"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.6"
+  s.rubygems_version = "2.2.2"
   s.summary = "Ruby binding for Ideone API"
 
   if s.respond_to? :specification_version then

data/lib/ideone.rb

@@ -2,135 +2,138 @@
 # information about the Ideone API consult
 # http://ideone.com/files/ideone-api.pdf
 #
-# Author::    Kenny Meyer  (knny.myer@gmail.com)
-# Copyright:: Copyright (c) 2011
+# Author::    Kenny Meyer  (kenny@kennymeyer.net)
+# Copyright:: Copyright (c) 2014
 # License::   Distributes under the same terms as Ruby
 
+require_relative 'ideone/exceptions'
 require 'savon' # SOAP Client
 
-class Ideone
-
-  def initialize(username=nil, password=nil)
-    @username = username
-    @password = password
-    
-    @client = Savon.client(wsdl: "http://ideone.com/api/1/service.wsdl")
-
-    HTTPI.log = false
-    
-    @request_body = {
-      :user => @username,
-      :pass => @password,
-    }
-    @languages_cache = nil
+module Ideone
+  def self.new(username, password, verbose=false)
+    return Ideone::Client.new(username, password, verbose)
   end
 
-  def create_submission(source_code, lang_id, std_input="", run=true,
-                        is_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] = is_private
-    response = @client.call(:create_submission, :message => @request_body)
-
-    check_error(response, :create_submission_response)
-    return response.to_hash[:create_submission_response][:return][:item][1][:value]
-  end
+  class Client
+    def initialize(username=nil, password=nil, verbose=false)
+      @client = Savon.client(wsdl: "http://ideone.com/api/1/service.wsdl", log: verbose)
+      @languages_cache = nil
+      @request_body = {
+        :user => username,
+        :pass => password,
+      }
+    end
 
-  def submission_status(link)
-    request_body = @request_body
-    request_body[:link] = link
-    response = @client.call(:get_submission_status, :message => request_body)
+    def create_submission(source_code, lang_id, std_input="", run=true,
+                          is_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] = is_private
 
-    check_error(response, :get_submission_status_response)
+      response = call_request(:create_submission, :message => @request_body)
 
-    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
-    
-    if status < 0
-      status = -1
+      return response.to_hash[:create_submission_response][:return][:item][1][:value]
     end
 
-    return { :status => status, :result => result }
-  end
+    def submission_status(link)
+      request_body = @request_body
+      request_body[:link] = link
 
-  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[:link] = link
-    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.call(:get_submission_details, :message => request_body)
-    
-    check_error(response, :get_submission_details_response)
-
-    details = response.to_hash[:get_submission_details_response][:return][:item]
-    
-    create_dict(details)
-  end
+      response = call_request(:get_submission_status, :message => request_body)
 
-  # Get a list of supported languages and cache it.
-  def languages
-    unless @languages_cache
-      response = @client.call(:get_languages, :message => @request_body)
+      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
 
-      check_error(response, :get_languages_response)
+      if status < 0
+        status = -1
+      end
 
-      languages = response.to_hash[:get_languages_response][:return][:item][1][:value][:item]
-      # Create a sorted hash
-      @languages_cache = Hash[create_dict(languages).sort_by{|k,v| k.to_i}]
+      return { :status => status, :result => result }
     end
-    return @languages_cache
-  end
-  
-  # A test function that always returns the same thing.
-  def test
-    response = @client.call(:test_function, :message => @request_body)
 
-    check_error(response, :test_function_response)
+    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[:link] = link
+      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 = call_request(:get_submission_details, :message => request_body)
+
+      details = response.to_hash[:get_submission_details_response][:return][:item]
+
+      create_dict(details)
+    end
 
-    items = response.to_hash[:test_function_response][:return][:item]
-    create_dict(items)
-  end
+    # Get a list of supported languages and cache it.
+    def languages
+      unless @languages_cache
+        response = call_request(:get_languages, :message => @request_body)
+
+        languages = response.to_hash[:get_languages_response][:return][:item][1][:value][:item]
+        # Create a sorted hash
+        @languages_cache = Hash[create_dict(languages).sort_by{|k,v| k.to_i}]
+      end
+      return @languages_cache
+    end
 
-  private
+    # A test function that always returns the same thing.
+    def test
+      response = call_request(:test_function, :message => @request_body)
 
-  def check_error(response, function_response)
-    error = get_error(response.to_hash, function_response)
-    if error != 'OK'
-      raise error
+      items = response.to_hash[:test_function_response][:return][:item]
+
+      return create_dict(items)
     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]
+
+    private
+
+    def check_error(response, function_response)
+      error = get_error(response.to_hash, function_response)
+      if error != 'OK'
+        raise Ideone::AuthError, "Invalid Ideone credentials provided"
+      end
     end
-  end
-  
-  def create_dict(items)
-    dict = {}
-    
-    items.each do |item|
-      key = item[:key]
-      value = item[:value]
-      value = "" if value == {:"@xsi:type"=>"xsd:string"}
-      dict[key] = value
+
+    def call_request(api_endpoint, **params)
+      begin
+        response = @client.call(api_endpoint, params)
+      rescue Exception => e
+        raise e
+      end
+      check_error(response, "#{api_endpoint}_response".to_sym)
+      return response
+    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]
+        value = "" if value == {:"@xsi:type"=>"xsd:string"}
+        dict[key] = value
+      end
+
+      dict
     end
-    
-    dict
   end
-  
 end

data/lib/ideone/exceptions.rb

@@ -0,0 +1,3 @@
+module Ideone
+  class AuthError < StandardError; end
+end

data/lib/ideone/version.rb

@@ -1,7 +1,7 @@
 class Ideone
   module Version
     MAJOR = 2
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/test/test_ideone-ruby-api.rb

@@ -6,18 +6,18 @@ PASS = 'testing' # YOUR IDEONE PASSWORD
 class TestIdeoneRubyApi < Test::Unit::TestCase
   def test_initialize
     omit_if(USER.empty? || PASS.empty?, "Specify ideone USER and PASS")
-    
-    instance = Ideone.new
+
+    instance = Ideone::Client.new
     assert_not_nil(instance)
-    
-    instance = Ideone.new(USER, PASS)
+
+    instance = Ideone::Client.new(USER, PASS)
     assert_not_nil(instance)
   end
 
   def test_ideone_test
     omit_if(USER.empty? || PASS.empty?, "Specify ideone USER and PASS")
-    
-    instance = Ideone.new(USER, PASS)
+
+    instance = Ideone::Client.new(USER, PASS)
 
     result = instance.test
 
@@ -31,8 +31,8 @@ class TestIdeoneRubyApi < Test::Unit::TestCase
 
   def test_languages
     omit_if(USER.empty? || PASS.empty?, "Specify ideone USER and PASS")
-    
-    instance = Ideone.new(USER, PASS)
+
+    instance = Ideone::Client.new(USER, PASS)
 
     result = instance.languages
 
@@ -42,8 +42,8 @@ class TestIdeoneRubyApi < Test::Unit::TestCase
 
   def test_create_submission
     omit_if(USER.empty? || PASS.empty?, "Specify ideone USER and PASS")
-    
-    instance = Ideone.new(USER, PASS)
+
+    instance = Ideone::Client.new(USER, PASS)
 
     code = <<-eos
 puts "This is a test submission created from ideone-ruby-api. https://github.com/kennym/ideone-gem/blob/master/lib/ideone.rb"
@@ -56,8 +56,8 @@ puts "This is a test submission created from ideone-ruby-api. https://github.com
 
   def test_submission_status
     omit_if(USER.empty? || PASS.empty?, "Specify ideone USER and PASS")
-    
-    instance = Ideone.new(USER, PASS)
+
+    instance = Ideone::Client.new(USER, PASS)
 
     result = instance.submission_status("PD2kqM")
 
@@ -65,11 +65,11 @@ puts "This is a test submission created from ideone-ruby-api. https://github.com
     assert_not_nil result[:status]
     assert_not_nil result[:result]
   end
-  
+
   def test_submission_details
     omit_if(USER.empty? || PASS.empty?, "Specify ideone USER and PASS")
-    
-    instance = Ideone.new(USER, PASS)
+
+    instance = Ideone::Client.new(USER, PASS)
 
     result = instance.submission_details("PD2kqM")
 

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ideone-ruby-api
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Kenny Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.3
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 description: 'A better Ruby binding for the Ideone API '
@@ -60,8 +60,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
 files:
-- .document
-- .travis.yml
+- ".document"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -69,6 +69,7 @@ files:
 - VERSION
 - ideone-ruby-api.gemspec
 - lib/ideone.rb
+- lib/ideone/exceptions.rb
 - lib/ideone/version.rb
 - test/helper.rb
 - test/test_ideone-ruby-api.rb
@@ -82,17 +83,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby binding for Ideone API