opencpu 0.7.1 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19b62c3506200ab96a85c1d5ad7a7d57a3c0651f
-  data.tar.gz: 5f7908fd6b2f370aaa88b9af023621b3a63cace0
+  metadata.gz: f069794c0f3a81cd0b450e272d420a6492e47483
+  data.tar.gz: 98eb45b503ce28cb028afb7ea35ae02df3e70e58
 SHA512:
-  metadata.gz: b56742bfe607853b48755e4a228ad6c2ef04a5b564361a4904b46203003284a03f9dd7c50336d0be3fdcabb99be0239e43c0365e014fbe625d30caec53e65dd1
-  data.tar.gz: 8a933198cc16b401e9221ec89f20c82621d472ed6e6046bb357c8e1659572d6146a69e81756971bd3c73e943c3b843784d0201888d3193694a9f35f55b4edd82
+  metadata.gz: 91bfef43f724e63b13012ac748b2121fa62bbb106debbe77a63086fff869ac2ef1bceb577b23692fd816ae85e95e3de7664d7ccb69d2bece38e43ee1b768cd1f
+  data.tar.gz: f385b0c5c4fc23811305397319b4ab3f42504ceecffc487e15a4d4c6b7611ac3fe5566e2aaff18b48c88d67a84567c7633242d4e4b9163674a77d2e3f8535dc6

data/README.md

@@ -26,6 +26,7 @@ Or install it yourself as:
 ```Ruby
 OpenCPU.configure do |config|
   config.endpoint_url = 'https://public.opencpu.org/ocpu'
+  config.timeout      = 30 # Timeout in seconds
 end
 ```
 
@@ -37,22 +38,45 @@ 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.
+One-step call always returns a JSON result from OpenCPU. This is a preferred
+way to use this gem, but keep in mind that not every R-package supports one-step
+responses. On OpenCPU server, packages can be installed under the system, but
+also under a particular user. This gem also provides a way to access both of them.
 
-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:
+**Access System Libraries**
+
+To get a response from the package installed under the system libraries just
+pass the package name, function and input data to the function. In the following
+example `:digest` is an R-package name, `:hmac` is a function and
+`{ key: 'foo', object: 'bar' }` is the input data, where `key` and `object` are
+parameters of `hmac` function:
+
+```Ruby
+client.execute :digest, :hmac, data: { key: 'foo', object: 'bar' }
+# => ['0c7a250281315ab863549f66cd8a3a53']
+```
+
+Above example is the same as the following (note the `user` parameter):
+
+```Ruby
+client.execute :digest, :hmac, user: :system, data: { key: 'foo', object: 'bar' }
+# => ['0c7a250281315ab863549f66cd8a3a53']
+```
+
+**Access User Libraries**
+
+To access a package installed under a particular user, just pass `user` parameter
+with the name of the existing user.
 
 ```Ruby
-client.execute :digest, :hmac, { key: 'foo', object: 'bar' }
+client.execute :digest, :hmac, user: :johndoe, data: { 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`.
+the same arguments as `#execute`, thus: `package`, `function`, `user` and `data`.
 
 ```Ruby
 calculations = client.prepare :animation, 'flip.coin'
@@ -116,7 +140,7 @@ calculations.info
 # => Returns information about R-environment of the script.
 ```
 
-## Test mode
+## Testing
 
 **NOTE:** Test mode is only supported in combination with `#execute` and the
 first step (`#prepare`) in two-step call.

data/lib/opencpu/client.rb

@@ -4,6 +4,7 @@ module OpenCPU
 
     def initialize
       self.class.base_uri OpenCPU.configuration.endpoint_url
+      self.class.default_timeout(OpenCPU.configuration.timeout) unless OpenCPU.configuration.timeout.nil?
     end
 
     def execute(package, function, user: :system, data: {})

data/lib/opencpu/configuration.rb

@@ -1,6 +1,7 @@
 module OpenCPU
   class Configuration
     attr_accessor :endpoint_url
+    attr_accessor :timeout
     attr_accessor :username
     attr_accessor :password
     attr_accessor :mode

data/lib/opencpu/version.rb

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

data/spec/lib/opencpu/client_spec.rb

@@ -21,14 +21,28 @@ describe OpenCPU::Client do
   end
 
   describe 'initializes' do
-    before do
-      OpenCPU.configure do |config|
-        config.endpoint_url = 'https://public.opencpu.org/ocpu'
+
+    describe 'without configured attributes' do
+      it 'uses the default timeout' do
+        expect(described_class.new.class.default_options[:timeout]).to be_nil
       end
     end
 
-    it 'with configured attributes' do
-      expect(described_class.new.class.base_uri).to eq 'https://public.opencpu.org/ocpu'
+    describe 'with configured attributes' do
+      before do
+        OpenCPU.configure do |config|
+          config.endpoint_url = 'https://public.opencpu.org/ocpu'
+          config.timeout      = 123
+        end
+      end
+
+      it 'sets the base uri' do
+        expect(described_class.new.class.base_uri).to eq 'https://public.opencpu.org/ocpu'
+      end
+
+      it 'sets the default_timeout' do
+        expect(described_class.new.class.default_options[:timeout]).to eq 123
+      end
     end
   end
 

metadata

@@ -1,187 +1,187 @@
 --- !ruby/object:Gem::Specification
 name: opencpu
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.3
 platform: ruby
 authors:
 - Ivan Malykh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.3'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 10.3.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
-    - - ">="
+    - - '>='
       - !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'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.17'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.17.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.17'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.17.4
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 4.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 4.2.8
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.0.0
 description: This gem wraps the OpenCPU REST API.
@@ -191,7 +191,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -224,17 +224,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Wrapper around OpenCPU REST API