opencpu 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b22793ec74be38b993028d6173a3c248c94ebded
-  data.tar.gz: 36dcb14376dd06f049e2777c7bddc72dfcf00d29
+  metadata.gz: b4dd7cd2e25675a883669dcc7b2dff60c3bed910
+  data.tar.gz: fb2c04876cdf97dc4c0656a5c24fd79718a22ffd
 SHA512:
-  metadata.gz: 6f8b357ba69afe78df0de40ef150183cdaf47c32dc0afad57211651f5c1175d7eac039f1a0354506ff920acadbea0344d433ceeda42787c6504bb78b6dbd0bb4
-  data.tar.gz: 03c3e679339495a20c1959daf76b630598fae225092a854888b966cdf7c44d441d313ac34bad0844c289ed81f0fd7d1446cff14575250e91a26738423f175996
+  metadata.gz: f3dcee9fba66c0e432feda4bb27e9b7b39f9453507dc5d26412d74fcfe576891bf09d82b8a0012b0df4d13646a529509248e72735108bcb0168c6ffdc1de9707
+  data.tar.gz: 490fac6cde42a5a53020c0b87d5029f24a2ee0b648608aed69b67090624a1da0c0c64b530cd41d1ff15cc56b0271b5544be7e92bff86b6b167e07afdf5a32896

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.9.2
+
+* Added `OpenCPU::Client#description` to retrieve a packages' description file
+
 # 0.9.1
 
 * Added `convert_na_to_nil=true/false` option to Client#execute

data/Gemfile

@@ -1,5 +1,11 @@
 source 'https://rubygems.org'
 
+group :development do
+  gem 'listen', '~> 3.0.8'
+  gem 'guard-rspec', '~> 4.2'
+  gem 'guard-bundler', '~> 2.0'
+end
+
 group :test do
   gem "codeclimate-test-reporter", require: nil
 end

data/README.md

@@ -161,6 +161,16 @@ If you want to send one or more files along, you can pass in a File object as da
 client.execute :foo, :bar, user: :johndoe, data: {file: File.new('/tmp/test.foo')}, format: :urlencoded
 ```
 
+**Package desciption**
+
+To access the entire content of a package's DESCRIPTION file
+```Ruby
+client.description :mypackage
+# => "Package: mypackage
+#     Version: 1.00
+#     ..."
+```
+
 ## Testing
 
 **NOTE:** Test mode is only supported in combination with `#execute` and the

data/lib/opencpu/client.rb

@@ -14,13 +14,21 @@ module OpenCPU
       github_remote             = options.fetch :github_remote, false
       should_convert_na_to_nil  = options.fetch :convert_na_to_nil, false
 
-      process_query package_url(package, function, user, github_remote, :json), data, format do |response|
+      process_query function_url(package, function, user, github_remote, :json), data, format do |response|
         output = JSON.parse(response.body)
         output = convert_na_to_nil(output) if should_convert_na_to_nil
         output
       end
     end
 
+    def description(package, options = {})
+      user          = options.fetch :user, :system
+      github_remote = options.fetch :github_remote, false
+
+      url = "#{package_url(package, user, github_remote)}/info"
+      self.class.get(url, request_options(nil, :json))
+    end
+
     def convert_na_to_nil(data)
       case data
       when 'NA'
@@ -39,7 +47,7 @@ module OpenCPU
       data = options.fetch :data, {}
       format = options.fetch :format, :json
       github_remote = options.fetch :github_remote, false
-      process_query package_url(package, function, user, github_remote), data, format do |response|
+      process_query function_url(package, function, user, github_remote), data, format do |response|
         location  = response.headers['location']
         resources = response.body.split(/\n/)
         OpenCPU::DelayedCalculation.new(location, resources)
@@ -70,10 +78,10 @@ module OpenCPU
 
       case format
       when :json
-        options[:body] = data.to_json
+        options[:body] = data.to_json if data
         options[:headers] =  {"Content-Type" => 'application/json'}
       when :urlencoded
-        options[:query] = data
+        options[:query] = data if data
       end
 
       if OpenCPU.configuration.username && OpenCPU.configuration.password
@@ -84,10 +92,14 @@ module OpenCPU
       options
     end
 
-    def package_url(package, function, user = :system, github_remote = false, format = nil)
-      return ['', 'library', package, 'R', function, format.to_s].join('/') if user == :system
-      return ['', 'github', user, package, 'R', function, format.to_s].join('/') if github_remote
-      return ['', 'user', user, 'library', package, 'R', function, format.to_s].join('/')
+    def function_url(package, function, user = :system, github_remote = false, format = nil)
+      "#{package_url(package, user, github_remote)}/R/#{function}/#{format.to_s}"
+    end
+
+    def package_url(package, user = :system, github_remote = false)
+      return "/library/#{package}" if user == :system
+      return "/github/#{user}/#{package}" if github_remote
+      return "/user/#{user}/library/#{package}"
     end
 
     def fake_response_for(url)

data/lib/opencpu/version.rb

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

data/opencpu.gemspec

@@ -28,6 +28,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec',          '~> 2.14',    '>= 2.14.1'
   spec.add_development_dependency 'webmock',        '~> 1.17',    '>= 1.17.4'
   spec.add_development_dependency 'vcr',            '~> 2.9',     '>= 2.9.0'
-  spec.add_development_dependency 'guard-rspec',    '~> 4.2',     '>= 4.2.8'
-  spec.add_development_dependency 'guard-bundler',  '~> 2.0',     '>= 2.0.0'
 end

data/spec/fixtures/vcr_cassettes/description.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://public.opencpu.org/ocpu/library/ade4/info
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.6 (Ubuntu)
+      Date:
+      - Fri, 10 Jun 2016 16:20:39 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - max-age=86400, public
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Expose-Headers:
+      - Location, X-ocpu-session, Content-Type, Cache-Control
+      Access-Control-Allow-Headers:
+      - Origin, Content-Type, Accept, Accept-Encoding, Cache-Control, Authorization
+      Access-Control-Allow-Credentials:
+      - 'true'
+      X-Ocpu-R:
+      - R version 3.3.0 (2016-05-03)
+      X-Ocpu-Locale:
+      - en_US.UTF-8
+      X-Ocpu-Time:
+      - 2016-06-10 09:18:55 PDT
+      X-Ocpu-Version:
+      - 1.6.2
+      X-Ocpu-Server:
+      - rApache
+      Vary:
+      - Accept-Encoding
+      X-Ocpu-Cache:
+      - HIT
+    body:
+      encoding: ASCII-8BIT
+      string: |
+        Package: My package
+        Type: Package
+    http_version: 
+  recorded_at: Fri, 10 Jun 2016 16:20:39 GMT
+recorded_with: VCR 2.9.3

data/spec/lib/opencpu/client_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe OpenCPU::Client do
+  let(:client) { described_class.new }
 
   before do
     OpenCPU.configure do |config|
@@ -47,7 +48,6 @@ describe OpenCPU::Client do
   end
 
   describe '#prepare' do
-    let(:client) { described_class.new }
     let(:delayed_calculation) { client.prepare('digest', 'hmac', data: { key: "baz", object: "qux" }) }
 
     it 'returns a DelayedCalculation' do
@@ -67,7 +67,6 @@ describe OpenCPU::Client do
     after do
       OpenCPU.disable_test_mode!
     end
-    let(:client) { described_class.new }
 
     it 'is used to quickly return JSON results' do
       VCR.use_cassette :animation_flip_coin, record: :new_episodes do
@@ -92,7 +91,7 @@ describe OpenCPU::Client do
     context 'url encoded request' do
       it 'sends the parameters url_encoded' do
         VCR.use_cassette :url_encoded_request do |cassette|
-          response = client.execute(:base, :identity, format: nil, data: { x: 'data.frame(x=1,y=1)' })
+          client.execute(:base, :identity, format: nil, data: { x: 'data.frame(x=1,y=1)' })
           params = cassette.serializable_hash['http_interactions'][0]['request']['body']['string']
           expect(params).to eq "x=data.frame(x%3D1%2Cy%3D1)"
         end
@@ -138,7 +137,6 @@ describe OpenCPU::Client do
         end
       end
       after { OpenCPU.reset_configuration! }
-      let(:client) { described_class.new }
 
       it "can access user packages" do
         VCR.use_cassette :user_digest_hmac do
@@ -155,7 +153,6 @@ describe OpenCPU::Client do
         end
       end
       after { OpenCPU.reset_configuration! }
-      let(:client) { described_class.new }
 
       it "can access github packages" do
         VCR.use_cassette :github_animation_flip_coin do
@@ -199,9 +196,17 @@ describe OpenCPU::Client do
     end
   end
 
-  describe "#convert_na_to_nil" do
-    let(:client) { described_class.new }
+  describe '#description' do
+    it 'returns the content of the package DESCRIPTION file' do
+      VCR.use_cassette :description do |cassette|
+        response = client.description('ade4')
+        expect(response.body).to eq "Package: My package\n" \
+                                    "Type: Package\n"
+      end
+    end
+  end
 
+  describe "#convert_na_to_nil" do
     it "converts 'NA' values in hashes in arrays" do
       res = client.convert_na_to_nil([4, {foo: 'NA'}])
       expect(res[1][:foo]).to be_nil
@@ -218,6 +223,38 @@ describe OpenCPU::Client do
     end
   end
 
+  describe '#function_url' do
+    before { allow(client).to receive(:package_url).and_return '<package url>' }
+
+    subject { client.send(:function_url, 'some_package', 'some_function', :kees, false, :json) }
+
+    it { is_expected.to eq '<package url>/R/some_function/json' }
+  end
+
+  describe '#package_url' do
+    let(:from_github) { false }
+
+    subject { client.send(:package_url, 'some_package', user, from_github) }
+
+    context ':system user' do
+      let(:user) { :system }
+      it { is_expected.to eq '/library/some_package' }
+    end
+
+    context 'other user' do
+      let(:user) { :kees }
+
+      context 'package is from GitHub' do
+        let(:from_github) { true }
+        it { is_expected.to eq '/github/kees/some_package' }
+      end
+
+      context 'other source' do
+        it { is_expected.to eq '/user/kees/library/some_package' }
+      end
+    end
+  end
+
   describe '#request_options' do
     it 'uses verify_ssl setting' do
       expect(described_class.new.send(:request_options, {}, nil)[:verify]).to be_truthy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opencpu
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Ivan Malykh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2016-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -144,46 +144,6 @@ dependencies:
     - - ">="
       - !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.
 email:
 - ivan@roqua.nl
@@ -208,6 +168,7 @@ files:
 - opencpu.gemspec
 - spec/fixtures/test.csv
 - spec/fixtures/vcr_cassettes/animation_flip_coin.yml
+- spec/fixtures/vcr_cassettes/description.yml
 - spec/fixtures/vcr_cassettes/digest_hmac.yml
 - spec/fixtures/vcr_cassettes/digest_hmac_no_parameters.yml
 - spec/fixtures/vcr_cassettes/github_animation_flip_coin.yml
@@ -241,13 +202,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Wrapper around OpenCPU REST API
 test_files:
 - spec/fixtures/test.csv
 - spec/fixtures/vcr_cassettes/animation_flip_coin.yml
+- spec/fixtures/vcr_cassettes/description.yml
 - spec/fixtures/vcr_cassettes/digest_hmac.yml
 - spec/fixtures/vcr_cassettes/digest_hmac_no_parameters.yml
 - spec/fixtures/vcr_cassettes/github_animation_flip_coin.yml