wise 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc66c5ea74b929be6c2faec1ac32aa51d09e0e34
+  data.tar.gz: ab3381a13ea13cc82f18dbd2eda3c982332bb320
+SHA512:
+  metadata.gz: daa4e6c22314bfc025b66999a8f2ea461d467d0961fe99ab1673fc7465780f66afa2c5790933a372bb06236897f57b9cbaa489417d89092a79101eb3774918b4
+  data.tar.gz: e19178c20e087d9ba69589f39c32277d7f644916ce79e5ecbf9b587442a07f3f0a1df4e9ee17a4ef5979e140d5e6c84fd90fe5b3669f4d8cce6911eb9018f9d3

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) <2013>, <wise.io LLC>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,62 @@
+= Wise.io for Ruby
+
+== Usage
+The following outlines the basic usage of the wise.io ruby library.
+
+=== Assumptions and limitations.
+At the moment, only predictions on already existent models in already existent 
+projects are supported. The library has been tested in Ruby 1.8.7p358 as well as
+in Ruby 2.0.0p0.
+
+=== Basic usage
+Connecting to a wise.io project can be done in two ways. The Wise::project method suffices, as illustrated by the following example:
+
+  Wise.project 'robin/quasars', :user => 'robin', :password => '...' do |p|
+    p.predict 'train', 'quasarsTest.csv'
+  end
+
+Alternately, a project handle may be created using Wise::Project.new:
+
+  p = Wise::Project.new 'robin/quasars', :user => 'robin', :password => '...'
+  p.predict 'train', 'quasarsTest.csv'
+
+=== Setting up a local wise.io profile
+To avoid having to supply user name and password every time a project handle is
+created, the +wise.rb+ binary supplied with the gem can be used to store 
+credentials in a local wise.io profile. To do this, simply run
+<tt>wise.rb --setup</tt> as follows:
+
+  $ wise.rb --setup
+  User: robin
+  Password: 
+  OK, wrote wise.io profile.
+
+If the supplied credentials are valid, connecting to a project and performing 
+predictions on a model is as simple as:
+
+  Wise.project 'robin/quasars' do |p|
+    p.predict 'train', :dataset => 'test'
+  end
+
+== License
+Copyright (c) <2013>, <wise.io LLC>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/bin/wise.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'etc'
+require 'optparse'
+require 'fileutils'
+
+require 'wise/version'
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: wise.rb [options]"
+  
+  opts.on_tail("-s", "--setup", "Setup wise.rb with username and password.") do
+    home = Etc.getpwuid.dir
+    wisedir = File.join home, ".wise"
+    profile = File.join wisedir, "profile"
+    
+    FileUtils.mkdir_p wisedir, :mode => 0700
+    
+    File.open(profile, "w") do |f|
+      print "User: "
+      user = gets.chomp
+      
+      print "Password: "
+      
+      system "stty -echo"
+      password = gets.chomp
+      system "stty echo"
+      print "\n"
+      
+      f.write "#{user}\n#{password}"
+    end
+    
+    FileUtils.chmod 0600, profile
+    
+    puts "OK, wrote wise.io profile."
+    exit
+  end
+  
+  opts.on_tail("-v", "--version", "Show version and exit.") do
+    puts "wise.rb, version #{Wise::VERSION}."
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+  puts optparse
+rescue OptionParser::InvalidOption
+  puts optparse
+  exit
+end

data/ext/restclient-ext.rb

@@ -0,0 +1,41 @@
+# Copyright (c) <2013>, <wise.io LLC>
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification, 
+# are permitted provided that the following conditions are met:
+#
+# - Redistributions of source code must retain the above copyright notice, 
+#   this list of conditions and the following disclaimer.
+#
+# - Redistributions in binary form must reproduce the above copyright notice, 
+#   this list of conditions and the following disclaimer in the documentation 
+#   and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+# INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
+# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+# REST Client is Copyright (c) 2008-2013 by the REST Client Team. See 
+# https://github.com/rest-client/rest-client for further information.
+# No ownership of, or affiliation to, REST Client or the REST Client Team is 
+# implied.
+
+module RestClient # :nodoc:
+  class Resource # :nodoc:
+    def get(additional_headers={}, &block)
+      payload = additional_headers.delete(:payload)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :get,
+              :url => url,
+              :payload => payload,
+              :headers => headers), &(block || @block))
+    end
+  end
+end

data/lib/wise.rb

@@ -0,0 +1,39 @@
+=begin
+---
+Copyright (c) <2013>, <wise.io LLC>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+=end
+module Wise
+end
+
+require 'rest_client'
+require 'json'
+require 'csv'
+require 'etc'
+
+$:.unshift(File.dirname(__FILE__))
+require File.join(File.dirname(__FILE__), '..', 'ext', 'restclient-ext.rb')
+
+require 'wise/client'
+require 'wise/project'
+require 'wise/version'

data/lib/wise/client.rb

@@ -0,0 +1,99 @@
+=begin
+---
+Copyright (c) <2013>, <wise.io LLC>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+=end
+
+module Wise
+  class AuthenticationError < StandardError # :nodoc:
+  end
+  class ResourceError < StandardError # :nodoc:
+  end
+  
+  class Client # :nodoc:
+    attr_reader :rest
+    
+    def initialize path, options
+      address = options[:address] || "https://wise.io"
+      owner, project = path.split("/")[1..2]
+      
+      user, pass = get_credentials options
+      
+      @rest = RestClient::Resource.new "#{address}/api", user, pass
+      
+      begin
+        raw = @rest['project/'].get(:params => {:name => project, 
+          :owner__username => owner, :limit => 1})
+      
+        obj = JSON.load(raw)['objects'][0]
+        @owner = obj['owner']
+        @project = obj['id']
+      rescue RestClient::Unauthorized
+        raise AuthenticationError.new "Invalid credentials given."
+      end
+    end
+    
+    def resource res
+      @rest[res]
+    end
+    
+    def get_credentials options
+      user, pass = nil
+    
+      if !options[:user].nil? && !options[:password].nil?
+        user, pass = [options[:user], options[:password]]
+      elsif File.exists?(prf = File.join(Etc.getpwuid.dir, ".wise", "profile"))
+        File.open(prf, "r") do |f|
+          user = f.readline.chomp
+          pass = f.readline.chomp
+        end
+      else
+        raise AuthenticationError.new "Credentials not given and profile not found."
+      end
+    
+      return [user, pass]
+    end
+    
+    def obj_id resource, obj
+      raw = @rest["#{resource}/"].get(:params => {:name => obj, 
+        :ordering => '-created_at', :project => @project, :limit => 1})
+      resp = JSON.load(raw)['objects'][0]
+      
+      raise ResourceError.new "Invalid #{resource} '#{obj}'." if resp.nil?
+      resp['id']
+    end
+    
+    def model_id obj
+      case obj
+      when Integer
+        obj
+      when String
+        obj_id('model', obj)
+      end
+    end
+    
+    def dataset_id dataset
+      obj_id('dataset', dataset)
+    end
+  end
+end

data/lib/wise/project.rb

@@ -0,0 +1,94 @@
+=begin
+---
+Copyright (c) <2013>, <wise.io LLC>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+=end
+
+module Wise
+  # Creates a project handle for a wise.io project with the given path, 
+  # yielding the project handle on succesful authentication; see 
+  # Wise::Project.new for the supported options.
+  def self.project path, options = {} # :yields: project
+    p = Project.new path, options
+    yield p if block_given?
+  end
+  
+  class Project
+    # Creates a project handle for an existing wise.io project.
+    # 
+    # === Parameters:
+    # [path] The project path (e.g. 'robin/quasars').
+    # [options] See below.
+    #
+    # === Options:
+    # [address] The base address to connect to; defaults to \https://wise.io.
+    # [user] Username used for authentication.
+    # [password] Password used for authentication.
+    # Note that user and password can be omitted if a wise.io profile is set up;
+    # if user and password are given as options, however, the profile is
+    # ignored.
+    def initialize path, options = {}
+      @client = Client.new path, options
+    end
+    
+    # Makes predictions on a model in the project. 
+    #
+    # === Parameters
+    # [model] 
+    #   The model label or id.
+    # [f] 
+    #   The data for the model to predict - this may take several forms: 
+    #   * If f is a *String* corresponding to a path to a file, the contents of
+    #     the file is used as the input; this is expected to be in a CSV format
+    #     compatible with the model.
+    #   * If f is an open *File*, its contents is used as input as above.
+    #   * If f is a *Hash*, it is interpreted as a selection. See {the 
+    #     selection API}[http://docs.wise.io/python.html#wise.project.select] 
+    #     for more information.
+    # [raw] 
+    #   If true, returns the result as raw CSV data rather than as an array.
+    #
+    # === Returns
+    # The predictions for the data as an array.
+    def predict model, f, raw = false
+      params = {}
+      
+      if (f.is_a? String) && (File.exists? File.join(Dir.pwd, f))
+        data = File.read(f)
+      elsif (f.is_a? File) && !f.closed?
+        data = f.read
+      elsif (f.is_a? Hash) && !f[:dataset].nil?
+        dataset = f.delete(:dataset)
+        data = f.to_json
+        params = {:dataset_id => (@client.dataset_id dataset)}
+      else
+        data = f
+      end
+      
+      m_id = @client.model_id model
+      resp = @client.resource("model/#{m_id}/predict").get(:payload => data, 
+        :params => params)
+      raw ? resp : CSV.parse(resp)
+    end
+  end
+end

data/lib/wise/version.rb

@@ -0,0 +1,29 @@
+=begin 
+---
+Copyright (c) <2013>, <wise.io LLC>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, 
+  this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright notice, 
+  this list of conditions and the following disclaimer in the documentation 
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+=end
+
+module Wise
+  VERSION = "0.1.1" # :nodoc:
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: wise
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Wise.io, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: A set of ruby bindings for communicating with the wise.io Machine Learning
+  as a Service platform.
+email: contact@wise.io
+executables:
+- wise.rb
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- lib/wise/client.rb
+- lib/wise/project.rb
+- lib/wise/version.rb
+- lib/wise.rb
+- ext/restclient-ext.rb
+- bin/wise.rb
+- LICENSE
+- README
+homepage: http://wise.io
+licenses:
+- See LICENSE.
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --title
+- Wise.io for Ruby
+- --main
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Ruby client for the Wise.io platform.
+test_files: []