ruby_cpu 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4689d3e9e79efaafe6d82fd2b114e8d552255ce
+  data.tar.gz: 68d1e03872e89aa472bf081e81363938c5b2bc5b
+SHA512:
+  metadata.gz: 9ccdf9c7818328bdf0fb8057067a0c0e6db14d21e5a0d67e3964eb4cce32c7f98d8e2191acd626fc6843519893637c2b0eb87f4ca055341b299cc949f3d498ce
+  data.tar.gz: e3430f8651f5db50f8c310369dfa573b5e2955d54fd2c308b2a3d43acea63b721c5f2b88f1c12d2d5ca35f36d65f0968fdbaf405039c47f91c0ab4232c5e0131

data/lib/ruby_cpu.rb

@@ -0,0 +1,89 @@
+class RubyCpu
+  #include WebserviceHelper
+  require 'rest_client'
+  require 'json'
+
+	require 'ruby_cpu/models/calculation_request'
+	require 'ruby_cpu/models/ocpu_callback'
+	require 'ruby_cpu/models/ocpu_package'
+	
+	require 'ruby_cpu/core_ext'
+	
+	require 'ruby_cpu/enums/return_type_enum'
+  
+  OCPU_PATH = "ocpu"
+  LIBRARY_PATH = "library"
+  LANGUAGE = "R"
+
+  def initialize serviceLocation
+    
+    # Remove the trailing slash, if present
+    serviceLocation.trim! "/"
+    
+    @service_location = serviceLocation
+    
+  end
+  
+  ##
+  # Returns a list of package objects, retrieved from the OpenCPU server
+  def library
+    
+   # Rails.logger.debug([@service_location, OCPU_PATH, LIBRARY_PATH].join("/"))
+    
+    packages = RestClient.get [@service_location, OCPU_PATH, LIBRARY_PATH].join("/")
+    
+    OcpuPackage.build_from_list packages
+    
+  end
+
+	##
+	# Returns information about a given +package+
+	def info package
+
+		data = RestClient.get [@service_location, OCPU_PATH, LIBRARY_PATH, package.name].join("/")
+		
+		data
+		
+	end
+  
+	##
+	# Calls the given server, with the +calculation_request+ and directly returns the data
+  def calculate_and_retrieve calculation_request
+    
+    data = calculate calculation_request
+    
+    retrieve_result data, ReturnTypeEnum::JSON
+  
+  end
+  
+  ##
+  # Can handle a certain calculation request. The +calculation_request+ passed
+  # to this function is sent to the OpenCPU service.
+  # This function returns the URLS on which the data can be retrieved.
+  def calculate calculation_request
+    
+    json_data = JSON.parse(calculation_request.data)
+
+    result = RestClient.post [@service_location, OCPU_PATH, LIBRARY_PATH, calculation_request.package, LANGUAGE, calculation_request.function].join('/'), calculation_request.data , :content_type => :json, :accept => :json
+    
+    OcpuCallback.build_from_response result
+    
+  end
+  
+  ##
+  # Retrieves the result from the given +session+ in the given +datatype+.
+  #
+  # OpenCPU first wants to store the data locally, in order to improve caching.
+  # When the call is performed, one gets a callback URL on which a get request 
+  # should be performed. This is done in this method.
+  def retrieve_result session, return_type 
+    
+    result = "{}"
+    
+    result = JSON.parse(RestClient.get [@service_location, session.value, return_type].join("/")) if session.is_a? OcpuCallback
+    
+    result
+    
+  end
+  
+end

data/lib/ruby_cpu/core_ext.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/core_ext/*.rb"].each do |file|
+  require file
+end

data/lib/ruby_cpu/core_ext/json.rb

@@ -0,0 +1 @@
+require 'ruby_cpu/core_ext/json/is_json'

data/lib/ruby_cpu/core_ext/json/is_json.rb

@@ -0,0 +1,10 @@
+module JSON
+  def self.is_json?(text)
+    begin
+      return false unless text.is_a?(String)
+      !!JSON.parse(text)
+    rescue JSON::ParserError
+      false
+    end 
+  end
+end

data/lib/ruby_cpu/core_ext/string.rb

@@ -0,0 +1 @@
+require 'ruby_cpu/core_ext/string/trim'

data/lib/ruby_cpu/core_ext/string/trim.rb

@@ -0,0 +1,9 @@
+class String
+  def trim char
+    self.gsub(/^#{char}|#{char}$/, "")
+  end
+  
+  def trim! char
+    self.gsub!(/^#{char}|#{char}$/, "")
+  end
+end

data/lib/ruby_cpu/enums/return_type_enum.rb

@@ -0,0 +1,4 @@
+module ReturnTypeEnum
+  JSON = "json"
+  CSV = "csv"
+end

data/lib/ruby_cpu/models/calculation_request.rb

@@ -0,0 +1,7 @@
+class CalculationRequest
+	
+	attr_accessor :package
+	attr_accessor :function
+	attr_accessor :data
+	
+end

data/lib/ruby_cpu/models/ocpu_callback.rb

@@ -0,0 +1,42 @@
+class OcpuCallback
+
+	attr_accessor :value
+	attr_accessor :stdout
+	attr_accessor :source
+	attr_accessor :console
+	attr_accessor :info
+	attr_accessor :session_code
+	
+  VALUE_LOCATION = 0
+  STDOUT_LOCATION = 1
+  SOURCE_LOCATION = 2
+  CONSOLE_LOCATION = 3
+  INFO_LOCATION = 4
+  
+  def self.build_from_response response_urls
+    
+    response_urls = response_urls.split("\n")
+    
+    ocpu_callback = new
+    
+    if response_urls.length >= 5 then
+      
+      ocpu_callback.value = response_urls[OcpuCallback::VALUE_LOCATION].trim "/"
+      
+      ocpu_callback.stdout = response_urls[OcpuCallback::STDOUT_LOCATION].trim "/"
+      
+      ocpu_callback.source = response_urls[OcpuCallback::SOURCE_LOCATION].trim "/"
+      
+      ocpu_callback.console = response_urls[OcpuCallback::CONSOLE_LOCATION].trim "/"
+      
+      ocpu_callback.info = response_urls[OcpuCallback::INFO_LOCATION].trim "/"
+      
+      ocpu_callback.session_code = ocpu_callback.value.split("/")[3]
+      
+    end
+    
+    ocpu_callback
+    
+  end
+  
+end

data/lib/ruby_cpu/models/ocpu_package.rb

@@ -0,0 +1,22 @@
+class OcpuPackage
+	
+	attr_accessor :name
+
+	def self.build_from_list package_list
+
+    package_list = package_list.split(" ")
+
+    packages = Array.new
+
+    package_list.each do |package| 
+      current_package = new
+			current_package.name = package
+      packages << current_package
+
+    end
+
+    packages
+
+  end
+	
+end

data/spec/lib/core_ext/json/is_json_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe JSON do
+		
+		before do
+			@json = '{"x":[1,4,2,3,5,3], "y":[1,6,7,5,4,3]}'
+			@not_json= "{x:[1,2,3,4],y:[4,3,2,1]}"
+  	end
+
+		it "should detect a string as being valid json" do
+			result = JSON.is_json? @json
+			result.should eq true
+		end
+
+		it "should detect a string as being invalid json" do
+			result = JSON.is_json? @not_json
+			result.should eq false
+		end
+
+end

data/spec/lib/core_ext/string/trim_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe String do
+		
+		before do
+			@data = "test"
+			@data_pre = "/#{@data}"
+			@data_ap = "#{@data}/"
+			@data_both = "/#{@data}/"
+			@data_both_multi = "/#{@data}/#{@data}/#{@data}/#{@data}/"
+  	end
+
+		it "remove a prepended char" do
+			result = @data_pre.trim "/"
+			result.should eq @data
+		end
+
+		it "remove a apended char" do
+			result = @data_ap.trim "/"
+			result.should eq @data
+		end
+		
+		it "remove both pre- and apended char" do
+			result = @data_both.trim "/"
+			result.should eq @data
+		end
+		
+		it "remove not remove inner chars" do
+			result = @data_both_multi.trim "/"
+			result.should eq "#{@data}/#{@data}/#{@data}/#{@data}"
+		end
+
+end

data/spec/lib/ruby_cpu_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe "An instance of", RubyCpu do
+		
+		before do
+			@calculation_request = CalculationRequest.new
+			@calculation_request.package = "stats"
+			@calculation_request.function = "cor"
+			@calculation_request.data = '{"x":[1,4,2,3,5,3], "y":[1,6,7,5,4,3]}'
+			@correlation = [0.32733]
+			
+			@ocpu_package = OcpuPackage.new
+			@ocpu_package.name = @calculation_request.package
+  	end
+    
+		before :each do
+    	@ruby_cpu = RubyCpu.new "https://public.opencpu.org"
+    end
+    
+    it "should be properly initialized" do
+    	expect(@ruby_cpu).to be_a(RubyCpu)
+			expect(@ocpu_package).to be_a(OcpuPackage)
+			expect(@calculation_request).to be_a(CalculationRequest)
+    end
+    
+    context "success" do
+	
+			it "returns information of a package" do
+				data = @ruby_cpu.info @ocpu_package
+				data.should be_a(String)
+				data.should include "Information on package '#{@ocpu_package.name}'"
+			end
+      
+    	it "returns a list of packages" do
+        
+     		result = @ruby_cpu.library
+        expect(result).to be_a(Array)
+        expect(result).not_to be_empty
+        
+      end
+      
+      it "returns an filled OcpuCallback object" do
+        
+        @callback = @ruby_cpu.calculate @calculation_request
+        expect(@callback).to be_a(OcpuCallback)
+        expect(@callback.source).not_to be_empty
+       	expect(@callback.value).not_to be_empty
+        expect(@callback.stdout).not_to be_empty
+        expect(@callback.console).not_to be_empty
+        expect(@callback.info).not_to be_empty
+        
+      end
+     		
+			it "should retrieve the correct results" do
+				@callback = @ruby_cpu.calculate @calculation_request
+				result = @ruby_cpu.retrieve_result @callback, "json"
+				expect(result).to eq(@correlation)
+      end
+
+			it "should calculate the correlation in one go" do
+				result = @ruby_cpu.calculate_and_retrieve @calculation_request
+				expect(result).to eq(@correlation)
+      end
+      
+    end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require 'rspec'
+require 'rspec/autorun'
+require 'ruby_cpu'
+
+# Setup coveralls
+require 'coveralls'
+Coveralls.wear!
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+	config.color_enabled = true
+	config.formatter     = 'documentation'
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: ruby_cpu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Frank Blaauw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem which exposes the OpenCPU interface to ruby
+email: frank.blaauw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ruby_cpu/core_ext/json/is_json.rb
+- lib/ruby_cpu/core_ext/json.rb
+- lib/ruby_cpu/core_ext/string/trim.rb
+- lib/ruby_cpu/core_ext/string.rb
+- lib/ruby_cpu/core_ext.rb
+- lib/ruby_cpu/enums/return_type_enum.rb
+- lib/ruby_cpu/models/calculation_request.rb
+- lib/ruby_cpu/models/ocpu_callback.rb
+- lib/ruby_cpu/models/ocpu_package.rb
+- lib/ruby_cpu.rb
+- spec/lib/core_ext/json/is_json_spec.rb
+- spec/lib/core_ext/string/trim_spec.rb
+- spec/lib/ruby_cpu_spec.rb
+- spec/spec_helper.rb
+homepage: http://frbl.eu
+licenses:
+- none
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.7
+signing_key: 
+specification_version: 4
+summary: RubyCPU
+test_files:
+- spec/lib/core_ext/json/is_json_spec.rb
+- spec/lib/core_ext/string/trim_spec.rb
+- spec/lib/ruby_cpu_spec.rb
+- spec/spec_helper.rb