opencpu 0.4.0 → 0.5.0

data/spec/fixtures/vcr_cassettes/digest_hmac.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://foo:bar@public.opencpu.org/ocpu/library/digest/R/hmac/json
+    uri: https://public.opencpu.org/ocpu/library/digest/R/hmac/json
     body:
       encoding: UTF-8
       string: '{"key":"baz","object":"qux"}'
@@ -15,13 +15,13 @@ http_interactions:
       message: OK
     headers:
       Server:
-      - nginx/1.4.1 (Ubuntu)
+      - nginx/1.4.6 (Ubuntu)
       Date:
-      - Thu, 10 Apr 2014 12:28:02 GMT
+      - Thu, 01 May 2014 14:34:19 GMT
       Content-Type:
       - application/json
       Location:
-      - https://public.opencpu.org/ocpu/tmp/x030f9d57/
+      - https://public.opencpu.org/ocpu/tmp/x0a6d5ac9c2/
       Transfer-Encoding:
       - chunked
       Connection:
@@ -29,7 +29,7 @@ http_interactions:
       Cache-Control:
       - max-age=300, public
       X-Ocpu-Session:
-      - x030f9d57
+      - x0a6d5ac9c2
       Access-Control-Allow-Origin:
       - "*"
       Access-Control-Allow-Headers:
@@ -37,20 +37,20 @@ http_interactions:
       Access-Control-Expose-Headers:
       - Location, X-ocpu-session, Content-Type, Cache-Control
       X-Ocpu-R:
-      - R version 3.1.0 beta (2014-03-28 r65330)
+      - R version 3.1.0 (2014-04-10)
       X-Ocpu-Locale:
       - en_US.UTF-8
       X-Ocpu-Time:
-      - 2014-04-10 05:28:02 PDT
+      - 2014-05-01 07:34:19 PDT
       X-Ocpu-Version:
-      - 1.2.99
+      - 1.4.1.99
       X-Ocpu-Server:
       - rApache
       X-Ocpu-Cache:
-      - MISS
+      - EXPIRED
     body:
       encoding: UTF-8
       string: "[\n\t\"22e2a7a268bf076801eefe7cd0119bb9\"\n]\n"
     http_version: 
-  recorded_at: Thu, 10 Apr 2014 12:28:03 GMT
+  recorded_at: Thu, 01 May 2014 14:34:22 GMT
 recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/digest_hmac_no_parameters.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://public.opencpu.org/ocpu/library/digest/R/hmac/json
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Thu, 01 May 2014 14:34:20 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Origin, Content-Type, Accept, Cache-Control
+      Access-Control-Expose-Headers:
+      - Location, X-ocpu-session, Content-Type, Cache-Control
+      X-Ocpu-R:
+      - R version 3.1.0 (2014-04-10)
+      X-Ocpu-Locale:
+      - en_US.UTF-8
+      X-Ocpu-Time:
+      - 2014-05-01 07:34:20 PDT
+      X-Ocpu-Version:
+      - 1.4.1.99
+      X-Ocpu-Server:
+      - rApache
+    body:
+      encoding: UTF-8
+      string: |
+        argument "key" is missing, with no default
+
+        In call:
+        makeRaw(k)
+    http_version: 
+  recorded_at: Thu, 01 May 2014 14:34:23 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/prepare.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://public.opencpu.org/ocpu/library/digest/R/hmac/
+    body:
+      encoding: UTF-8
+      string: '{"key":"baz","object":"qux"}'
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Thu, 01 May 2014 14:34:16 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Location:
+      - https://public.opencpu.org/ocpu/tmp/x0a79915480/
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - max-age=300, public
+      X-Ocpu-Session:
+      - x0a79915480
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Origin, Content-Type, Accept, Cache-Control
+      Access-Control-Expose-Headers:
+      - Location, X-ocpu-session, Content-Type, Cache-Control
+      X-Ocpu-R:
+      - R version 3.1.0 (2014-04-10)
+      X-Ocpu-Locale:
+      - en_US.UTF-8
+      X-Ocpu-Time:
+      - 2014-05-01 07:34:16 PDT
+      X-Ocpu-Version:
+      - 1.4.1.99
+      X-Ocpu-Server:
+      - rApache
+      X-Ocpu-Cache:
+      - EXPIRED
+    body:
+      encoding: UTF-8
+      string: |
+        /ocpu/tmp/x0a79915480/R/.val
+        /ocpu/tmp/x0a79915480/stdout
+        /ocpu/tmp/x0a79915480/warnings
+        /ocpu/tmp/x0a79915480/source
+        /ocpu/tmp/x0a79915480/console
+        /ocpu/tmp/x0a79915480/info
+    http_version: 
+  recorded_at: Thu, 01 May 2014 14:34:19 GMT
+recorded_with: VCR 2.9.0

data/spec/lib/opencpu/client_spec.rb

@@ -2,49 +2,75 @@ require 'spec_helper'
 
 describe OpenCPU::Client do
 
+  before do
+    OpenCPU.configure do |config|
+      config.endpoint_url = 'https://public.opencpu.org/ocpu'
+    end
+  end
+
   it 'initializes with HTTParty' do
     expect(described_class.ancestors).to include HTTParty
   end
 
-  it 'provides #default_options' do
-    expect(described_class.new).to respond_to :default_options
+  it 'defines #execute' do
+    expect(described_class.new).to respond_to :execute
+  end
+
+  it 'defines #prepare' do
+    expect(described_class.new).to respond_to :prepare
   end
 
-  context 'configured' do
+  describe 'initializes' do
     before do
       OpenCPU.configure do |config|
         config.endpoint_url = 'https://public.opencpu.org/ocpu'
-        config.username     = 'foo'
-        config.password     = 'bar'
       end
     end
 
-    it 'initializes with configured attributes' do
+    it 'with configured attributes' do
       expect(described_class.new.class.base_uri).to eq 'https://public.opencpu.org/ocpu'
-      expect(described_class.new.default_options).to eq({basic_auth: {username: 'foo', password: 'bar'}})
     end
   end
 
-  it 'defines #execute' do
-    expect(described_class.new).to respond_to :execute
+  describe '#prepare' do
+    let(:client) { described_class.new }
+    let(:delayed_calculation) { client.prepare('digest', 'hmac', key: "baz", object: "qux") }
+
+    it 'returns a DelayedCalculation' do
+      VCR.use_cassette :prepare do
+        expect(delayed_calculation).to be_a OpenCPU::DelayedCalculation
+      end
+    end
+
+    it 'returns a DelayedCalculation with correct path' do
+      VCR.use_cassette :prepare do
+        expect(delayed_calculation.location).to eq "https://public.opencpu.org/ocpu/tmp/x0a79915480/"
+      end
+    end
   end
 
   describe '#execute' do
-    before do
-      OpenCPU.configure do |config|
-        config.endpoint_url = 'https://public.opencpu.org/ocpu'
-        config.username     = 'foo'
-        config.password     = 'bar'
+    let(:client) { described_class.new }
+
+    it 'is used to quickly return JSON results' do
+      VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+        response = client.execute(:animation, 'flip.coin')
+        expect(response).to eq "freq" => [0.56, 0.44], "nmax" => [50]
       end
     end
 
-    let(:client) { described_class.new }
+    it 'accepts R-function parameters as data' do
+      VCR.use_cassette :digest_hmac, record: :new_episodes do
+        response = client.execute(:digest, :hmac, key: 'baz', object: 'qux')
+        expect(response).to eq ["22e2a7a268bf076801eefe7cd0119bb9"]
+      end
+    end
 
-    it 'returns a correct HMAC response' do
-      VCR.use_cassette :digest_hmac do
-        response = client.execute('digest', 'hmac', key: 'baz', object: 'qux')
-        expect(response[0]).to eq '22e2a7a268bf076801eefe7cd0119bb9'
+    it 'raises 400 with body' do
+      VCR.use_cassette :digest_hmac_no_parameters do
+        expect { client.execute(:digest, :hmac) }.to raise_error
       end
     end
   end
+
 end

data/spec/lib/opencpu/delayed_calculation_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+
+describe OpenCPU::DelayedCalculation do
+
+  let(:delayed_calculation) { described_class.new 'foo' }
+  
+  describe "initializes" do
+    it "without resources" do
+      delayed_calculation = described_class.new 'foo'
+      expect(delayed_calculation.available_resources).to eq Hash.new
+    end
+
+    let(:resources) do
+      [
+        '/foo/bar',
+        '/foo/baz'
+      ]
+    end
+    let(:parsed_resources) do
+      {
+        bar: URI.parse('https://opencpu.org/foo/bar'),
+        baz: URI.parse('https://opencpu.org/foo/baz')
+      }
+    end
+    it "with resources" do
+      delayed_calculation = described_class.new 'https://opencpu.org/foo/', resources
+      expect(delayed_calculation.available_resources).to eq parsed_resources
+    end    
+  end
+
+  let(:location) { "https://public.opencpu.org/ocpu/tmp/x09dd995a16/" }
+  let(:resources) do
+    [
+      "/ocpu/tmp/x09dd995a16/R/.val",
+      "/ocpu/tmp/x09dd995a16/graphics/1",
+      "/ocpu/tmp/x09dd995a16/graphics/2",
+      "/ocpu/tmp/x09dd995a16/graphics/3",
+      "/ocpu/tmp/x09dd995a16/graphics/4",
+      "/ocpu/tmp/x09dd995a16/source",
+      "/ocpu/tmp/x09dd995a16/console",
+      "/ocpu/tmp/x09dd995a16/info"
+    ]
+  end
+  let(:delayed_calculation) { described_class.new location, resources }
+  
+  describe "#graphics" do
+
+    it 'defines methods to access graphic functions' do
+      VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+        expect { delayed_calculation.graphics }.not_to raise_error
+        expect { delayed_calculation.stdout }.to raise_error OpenCPU::ResponseNotAvailableError
+      end
+    end
+
+    it "returns a SVG by default" do
+      VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+        expect(delayed_calculation.graphics).to include 'svg xmlns'
+      end
+    end
+
+    it "can return a PNG" do
+      VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+        expect(delayed_calculation.graphics(0, :png)).to include 'PNG'
+      end
+    end
+
+    it "does not support formats except PNG and SVG" do
+      VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+        expect { delayed_calculation.graphics(0, :svg) }.not_to raise_error
+        expect { delayed_calculation.graphics(0, :png) }.not_to raise_error
+        expect { delayed_calculation.graphics(0, :foo) }.to raise_error OpenCPU::UnsupportedFormatError
+        expect { delayed_calculation.graphics(0, :bar) }.to raise_error OpenCPU::UnsupportedFormatError
+      end
+    end
+
+    it 'can handle multiple graphic output' do
+      
+    end
+  end
+
+  describe 'standard getters' do
+    describe '#value' do
+      it "returns raw R calculation result" do
+        VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+          expect(delayed_calculation.value).to eq "$freq\n   1    2 \n0.52 0.48 \n\n$nmax\n[1] 50"
+        end
+      end
+    end
+
+    describe '#stdout' do
+      it "returns cached stdout" do
+        VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+          expect { delayed_calculation.stdout }.to raise_error OpenCPU::ResponseNotAvailableError
+        end
+      end
+    end
+
+    describe '#warnings' do
+      it 'returns cached warnings' do
+        VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+          expect { delayed_calculation.warnings }.to raise_error OpenCPU::ResponseNotAvailableError
+        end
+      end      
+    end
+
+    describe '#info' do
+      it 'returns cached info' do
+        VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+          expect(delayed_calculation.info).to include("R version")
+        end
+      end
+    end
+
+    # describe "#console" do
+    #   it 'returns cached console input' do
+    #     VCR.use_cassette :animation_flip_coin, record: :new_episodes do
+    #       expect(delayed_calculation.console).to include("hmac(key = \"baz\", object = \"qux\"")
+    #     end
+    #   end
+    # end
+  end
+end

data/spec/lib/{opencpu.rb → opencpu_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path('../../spec_helper.rb', __dir__)
+require 'spec_helper'
 
 describe OpenCPU do
 
@@ -26,7 +26,4 @@ describe OpenCPU do
     end
   end
 
-  describe '#client' do
-
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opencpu
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ivan Malykh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -84,16 +84,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.4
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -153,12 +153,17 @@ files:
 - lib/opencpu.rb
 - lib/opencpu/client.rb
 - lib/opencpu/configuration.rb
+- lib/opencpu/delayed_calculation.rb
 - lib/opencpu/version.rb
 - opencpu.gemspec
+- spec/fixtures/vcr_cassettes/animation_flip_coin.yml
 - spec/fixtures/vcr_cassettes/digest_hmac.yml
-- spec/lib/opencpu.rb
+- spec/fixtures/vcr_cassettes/digest_hmac_no_parameters.yml
+- spec/fixtures/vcr_cassettes/prepare.yml
 - spec/lib/opencpu/client_spec.rb
 - spec/lib/opencpu/configuration_spec.rb
+- spec/lib/opencpu/delayed_calculation_spec.rb
+- spec/lib/opencpu_spec.rb
 - spec/spec_helper.rb
 homepage: http://roqua.nl
 licenses:
@@ -180,13 +185,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Wrapper around OpenCPU REST API
 test_files:
+- spec/fixtures/vcr_cassettes/animation_flip_coin.yml
 - spec/fixtures/vcr_cassettes/digest_hmac.yml
-- spec/lib/opencpu.rb
+- spec/fixtures/vcr_cassettes/digest_hmac_no_parameters.yml
+- spec/fixtures/vcr_cassettes/prepare.yml
 - spec/lib/opencpu/client_spec.rb
 - spec/lib/opencpu/configuration_spec.rb
+- spec/lib/opencpu/delayed_calculation_spec.rb
+- spec/lib/opencpu_spec.rb
 - spec/spec_helper.rb