opencpu 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34c952212689a1551ecfcb120620c509f11e8524
-  data.tar.gz: e7962d79b6ffca4407d2fb677ca8703e5ff8ed57
+  metadata.gz: c7fa48f6ada8ed51e24bd637e2f5accb66f21236
+  data.tar.gz: 03bec11de590ae6e37cf14827db242e009aab50d
 SHA512:
-  metadata.gz: 813129283d4c47ef0da68327772940d2a715eeac3111e11ce97766a590cad61beb5f9e9f33b4217c5291e3155ef2952771a05fe9e266eb175746e54c5d844616
-  data.tar.gz: 5f1ee6a0a9948020c5d058cf688988cec3d4d5f71f99ca25940b063cabb5bc279332a2bc56bfbbaef7d32d003a4096102c29379af40a4940db6d17b27a66393b
+  metadata.gz: 90622347a231242315ad05ab6626cd4e49242792c1d3606a201eee06417dfd09d8c46fbcf9e8659fceb205f0baaea6fcd32e09eacce47b1466b31012583bba5d
+  data.tar.gz: 1c25c6bb72e88d2bd340c54011a6a7cc6be1ee3f314e8ef57dd47ff4a969b9304975f00d0b2b00c2b239dd040a2f41ae531b2933d2b83a69912a149445b28960

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+end
 # Specify your gem's dependencies in opencpu.gemspec
 gemspec

data/README.md

@@ -2,6 +2,9 @@
 
 ![Build Status](https://circleci.com/gh/roqua/opencpu.png?circle-token=4689df66bef26cd4aff65a4893c25400795b408a)
 
+[![Code Climate](https://codeclimate.com/github/roqua/opencpu.png)](https://codeclimate.com/github/roqua/opencpu)
+[![Dependency Status](https://gemnasium.com/roqua/opencpu.svg)](https://gemnasium.com/roqua/opencpu)
+
 Roqua wrapper for the OpenCPU REST API.
 
 ## Installation
@@ -18,10 +21,119 @@ Or install it yourself as:
 
     $ gem install opencpu
 
+## Configuration
+
+```Ruby
+OpenCPU.configure do |config|
+  config.endpoint_url = 'https://public.opencpu.org/ocpu'
+end
+```
+
 ## Usage
 
-    data = { '.someFunction': [{ x: [1,2,3,4,5], y: [7,3,9,4,1] }]}
-    response = OpenCPU.execute 'PackageName', 'ScriptName', data
+```Ruby
+client = OpenCPU.client
+```
+
+### One-step call
+
+One-step call always returns a JSON result from OpenCPU. However this is a
+preferred way to use this gem, not every R-package supports one-step responses.
+
+To get a response just pass a package name, function and the payload to the
+function. In the following example `:digest` is an R-package name, `:hmac` is a
+function and `{ key: 'foo', object: 'bar' }` is the payload:
+
+```Ruby
+client.execute :digest, :hmac, { key: 'foo', object: 'bar' }
+# => ['0c7a250281315ab863549f66cd8a3a53']
+```
+
+### Two-steps way
+
+To prepare the calculations on OpenCPU execute the `#prepare` method. It accepts
+the same arguments as `#execute`.
+
+```Ruby
+calculations = client.prepare :animation, 'flip.coin'
+```
+
+`calculations` variable now holds the reference URL's to the calculations made
+by OpenCPU. These URL are available through one of the following methods. Which
+of them are available depends on the package and possible response it can
+generate.
+
+**#graphics(obj, type)**
+
+```Ruby
+calculations.graphics
+# => Returns the first SVG created by OpenCPU.
+calculations.graphics(1)
+# => Returns the second SVG created by OpenCPU.
+calculations.graphics(1, :png)
+# => Returns the second PNG created by OpenCPU.
+```
+
+**#value**
+
+```Ruby
+calculations.value
+# => Returns the raw output of the R-function.
+```
+
+**#stdout**
+
+```Ruby
+calculations.stdout
+# => Returns the raw output of stdout being written at the runtime.
+```
+
+**#warnings**
+
+```Ruby
+calculations.warnings
+# => Returns the warnings returned by the script.
+```
+
+**#source**
+
+```Ruby
+calculations.source
+# => Returns the source of the script.
+```
+
+**#console**
+
+```Ruby
+calculations.console
+# => Returns the output from R-console.
+```
+
+**#info**
+
+```Ruby
+calculations.info
+# => Returns information about R-environment of the script.
+```
+
+## Test mode
+
+OpenCPU gem provides a test mode. It basically disables all HTTP interactions
+with provided OpenCPU server. It is very handy when testing your software for
+example. You can easily turn it on:
+
+```Ruby
+OpenCPU.enable_test_mode!
+```
+
+After that you can set fake responses per package/script combination:
+
+```Ruby
+OpenCPU.set_fake_response! :digest, :hmac, 'foo'
+```
+
+This will allways return `'foo'` when calling function `hmac` in package
+`digest`.
 
 ## Contributing
 

data/circle.yml

@@ -1,3 +1,5 @@
 machine:
+  environment:
+    CODECLIMATE_REPO_TOKEN: ecaec3d271bf32a8e203cafb71cc565d57a86dc0571b5529b491935e786001ff 
   ruby:
-    version: 2.1.0
+    version: 2.1.0

data/lib/opencpu/version.rb

@@ -1,6 +1,6 @@
 module OpenCPU
   MAJOR = 0
   MINOR = 6
-  TINY  = 0
+  TINY  = 1
   VERSION = [MAJOR, MINOR, TINY].join('.')
 end

data/opencpu.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency             'yajl-ruby',    '~> 1.2.0'
-  spec.add_dependency             'httparty',     '~> 0.12.0'
+  spec.add_dependency             'httparty',     '~> 0.13.1'
   spec.add_development_dependency 'bundler',      '~> 1.5'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec',        '~> 2.14.1'

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'vcr'
 
 require File.expand_path('../lib/opencpu.rb', __dir__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opencpu
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Ivan Malykh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement