opencpu 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80e23592402ef0e7144b60fe3fdf523f911f3d6b
+  data.tar.gz: 39af7f9a7ecb1975536383491de69b5c734c9e7c
+SHA512:
+  metadata.gz: 2a6fd3aae53df745326ed6f5a04657c15dd2eb9850d2b63d0dbb9119d27c33ea89f232fe8776ecbee59544cb480785963077c1c24d4b8cfdfec2c98ad1493b49
+  data.tar.gz: 601a69a6d3d9bf7c1b21dbd59a1e29365c7bc38b008b6734a2f1463591efe151e942fd369511fe79c4f9a33032854309fc7617960161fbb386322de2e3084ed4

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in opencpu.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 RoQua
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# Roqua::OpenCPU
+
+Roqua wrapper for the OpenCPU REST API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opencpu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opencpu
+
+## Usage
+
+    data = { '.someFunction': [{ x: [1,2,3,4,5], y: [7,3,9,4,1] }]}
+    response = OpenCPU.execute 'PackageName', 'ScriptName', data
+
+## Contributing
+
+1. Fork it ( http://github.com/roqua/opencpu/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.1.0

data/lib/opencpu.rb

@@ -0,0 +1,32 @@
+require 'httparty'
+require 'yajl'
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+
+module OpenCPU
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.client
+    OpenCPU::Client.new
+  end
+
+  def self.configuration
+    @configuration ||= OpenCPU::Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
+
+
+require "opencpu/configuration"
+require "opencpu/client"
+require "opencpu/version"

data/lib/opencpu/client.rb

@@ -0,0 +1,37 @@
+module OpenCPU
+  class Client
+    class UnsupportedHTTPMethod < StandardError; end
+    include HTTParty
+    format   :json
+    headers  'Content-Type' => 'application/json'
+
+    def initialize
+      self.class.base_uri OpenCPU.configuration.endpoint_url
+    end
+
+    def default_options
+      {
+        basic_auth: {
+          username: OpenCPU.configuration.username,
+          password: OpenCPU.configuration.password
+        }
+      }
+    end
+
+    def execute(package, function, data = {}, method = :post)
+      raise UnsupportedHTTPMethod if unsupported_http_method? method
+      options = default_options.merge body: data.to_json
+      self.class.send(method, "/library/#{package}/R/#{function}/json", options)
+    end
+
+    private
+
+    def supported_http_methods
+      [:post]
+    end
+
+    def unsupported_http_method?(method)
+      !supported_http_methods.include? method
+    end
+  end
+end

data/lib/opencpu/configuration.rb

@@ -0,0 +1,7 @@
+module OpenCPU
+  class Configuration
+    attr_accessor :endpoint_url
+    attr_accessor :username
+    attr_accessor :password
+  end
+end

data/lib/opencpu/version.rb

@@ -0,0 +1,3 @@
+module OpenCPU
+  VERSION = "0.4.0"
+end

data/opencpu.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opencpu/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opencpu"
+  spec.version       = OpenCPU::VERSION
+  spec.authors       = ["Ivan Malykh"]
+  spec.email         = ["ivan@roqua.nl"]
+  spec.summary       = %q{Wrapper around OpenCPU REST API}
+  spec.description   = %q{This gem wraps the OpenCPU REST API.}
+  spec.homepage      = "http://roqua.nl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency             'yajl-ruby',    '~> 1.2.0'
+  spec.add_dependency             'httparty',     '~> 0.12.0'
+  spec.add_development_dependency 'bundler',      '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec',        '~> 2.14.1'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr',          '~> 2.9.0'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-bundler'
+end

data/spec/fixtures/vcr_cassettes/digest_hmac.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://foo:bar@public.opencpu.org/ocpu/library/digest/R/hmac/json
+    body:
+      encoding: UTF-8
+      string: '{"key":"baz","object":"qux"}'
+    headers:
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.1 (Ubuntu)
+      Date:
+      - Thu, 10 Apr 2014 12:28:02 GMT
+      Content-Type:
+      - application/json
+      Location:
+      - https://public.opencpu.org/ocpu/tmp/x030f9d57/
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - max-age=300, public
+      X-Ocpu-Session:
+      - x030f9d57
+      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 beta (2014-03-28 r65330)
+      X-Ocpu-Locale:
+      - en_US.UTF-8
+      X-Ocpu-Time:
+      - 2014-04-10 05:28:02 PDT
+      X-Ocpu-Version:
+      - 1.2.99
+      X-Ocpu-Server:
+      - rApache
+      X-Ocpu-Cache:
+      - MISS
+    body:
+      encoding: UTF-8
+      string: "[\n\t\"22e2a7a268bf076801eefe7cd0119bb9\"\n]\n"
+    http_version: 
+  recorded_at: Thu, 10 Apr 2014 12:28:03 GMT
+recorded_with: VCR 2.9.0

data/spec/lib/opencpu.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../../spec_helper.rb', __dir__)
+
+describe OpenCPU do
+
+  it 'responds to #client' do
+    expect(described_class).to respond_to :client
+  end
+
+  it 'responds to #configure' do
+    expect(described_class).to respond_to :configure
+  end
+
+  it 'responds to #configuration' do
+    expect(described_class).to respond_to :configuration
+  end
+
+  describe '#configure' do
+    before do
+      described_class.configure do |config|
+        config.endpoint_url = 'http://somehost.com/opencpu'
+      end
+    end
+
+    it "can configure" do
+      expect(described_class.configuration.endpoint_url).to eq 'http://somehost.com/opencpu'
+    end
+  end
+
+  describe '#client' do
+
+  end
+end

data/spec/lib/opencpu/client_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe OpenCPU::Client do
+
+  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
+  end
+
+  context 'configured' 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
+      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
+  end
+
+  describe '#execute' do
+    before do
+      OpenCPU.configure do |config|
+        config.endpoint_url = 'https://public.opencpu.org/ocpu'
+        config.username     = 'foo'
+        config.password     = 'bar'
+      end
+    end
+
+    let(:client) { described_class.new }
+
+    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'
+      end
+    end
+  end
+end

data/spec/lib/opencpu/configuration_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe OpenCPU::Configuration do
+
+  it 'has an #endpoint_url' do
+    expect(described_class.new).to respond_to :endpoint_url
+  end
+
+  it 'has a #username' do
+    expect(described_class.new).to respond_to :username
+  end
+
+  it 'has a #password' do
+    expect(described_class.new).to respond_to :password
+  end
+
+  describe '#endpoint_url=' do
+    it 'sets an url' do
+      config = described_class.new
+      config.endpoint_url = 'http://test.com'
+      expect(config.endpoint_url).to eq 'http://test.com'
+    end
+  end
+
+  describe '#username=' do
+    it 'sets a username' do
+      config = described_class.new
+      config.username = 'foo'
+      expect(config.username).to eq 'foo'
+    end
+  end
+
+  describe '#password=' do
+    it 'sets the password' do
+      config = described_class.new
+      config.password = 'bar'
+      expect(config.password).to eq 'bar'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'vcr'
+
+require File.expand_path('../lib/opencpu.rb', __dir__)
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: opencpu
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Ivan Malykh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-10 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !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: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  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: This gem wraps the OpenCPU REST API.
+email:
+- ivan@roqua.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circle.yml
+- lib/opencpu.rb
+- lib/opencpu/client.rb
+- lib/opencpu/configuration.rb
+- lib/opencpu/version.rb
+- opencpu.gemspec
+- spec/fixtures/vcr_cassettes/digest_hmac.yml
+- spec/lib/opencpu.rb
+- spec/lib/opencpu/client_spec.rb
+- spec/lib/opencpu/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: http://roqua.nl
+licenses:
+- MIT
+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.3
+signing_key: 
+specification_version: 4
+summary: Wrapper around OpenCPU REST API
+test_files:
+- spec/fixtures/vcr_cassettes/digest_hmac.yml
+- spec/lib/opencpu.rb
+- spec/lib/opencpu/client_spec.rb
+- spec/lib/opencpu/configuration_spec.rb
+- spec/spec_helper.rb