machine_classifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1bab4de07763dcf153a9671580b246120cc590e
+  data.tar.gz: d15d5e884869e026103eb07f0b2ffa399bec16a9
+SHA512:
+  metadata.gz: d4739013aa0015231592b7aec1d461c76f7cb1385612fad180fb7ed373c5c2a3f2d6b450db05c79c88e8a995ac74f1e63ace3149426e0f4097ebb612b262954d
+  data.tar.gz: 35bf27dc5a68fc51457493b14e76eb1da624a951e254cdcb84e4b9bb7ce19d66866b42f08e51a628d143779dd956eb9476e1909184bcbdb880300f77a1822b20

data/.gitignore

@@ -0,0 +1,5 @@
+/bin/stubs
+.bundle
+*.gem
+Gemfile.lock
+pkg

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Riccardo Lucatuorto
+
+
+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,55 @@
+# MachineClassifier
+
+MachineClassifier is a thin wrapper around the APIs used to
+call machine learning classification systems.
+
+Currently, only Google Prediction is supported.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'machine_classifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install machine_classifier
+
+## Usage
+
+### Google Prediction
+
+```ruby
+require 'machine_classifier'
+
+text = 'Some text that I want to classify'
+
+configuration = MachineClassifier::Configuration.new do |conf|
+  conf.api_version           = '1.6'
+  conf.developer_email       = 'developer_email@example.com'
+  conf.private_key           = 'Binary data'
+  conf.private_key_password  = 'private_key_password'
+  conf.project               = 'Google Prediction Project Name'
+  conf.model                 = 'Google Prediction Model'
+  conf.application_name      = 'My Appliction'
+  conf.application_version   = '1.0.0'
+end
+
+client = MachineClassifier::Client.new(configuration)
+result = client.call(text)
+raise 'Classification call failed' if not result.success?
+puts "Text: #{text}"
+puts "Label: #{result.winner}"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/machine_classifier/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/machine_classifier.rb

@@ -0,0 +1,9 @@
+require 'machine_classifier/version'
+require 'machine_classifier/client'
+require 'machine_classifier/authorizer'
+require 'machine_classifier/result'
+require 'machine_classifier/configuration'
+
+module MachineClassifier
+  # Your code goes here...
+end

data/lib/machine_classifier/authorizer.rb

@@ -0,0 +1,23 @@
+module MachineClassifier
+  class Authorizer < Struct.new(:configuration)
+    SERVICE_URL = 'https://www.googleapis.com/auth/prediction'
+
+    def authorize
+      service_account.authorize
+    end
+
+    private
+
+    def service_account
+      @service_account ||= Google::APIClient::JWTAsserter.new(
+        configuration.developer_email,
+        SERVICE_URL,
+        key
+      )
+    end
+
+    def key
+      OpenSSL::PKCS12.new(configuration.private_key, configuration.private_key_password).key
+    end
+  end
+end

data/lib/machine_classifier/client.rb

@@ -0,0 +1,78 @@
+require 'google/api_client'
+
+module MachineClassifier
+  class Client < Struct.new(:configuration)
+    HEADERS = {'Content-Type' => 'application/json'}
+
+    def call(text)
+      authorize!
+
+      predict       = prediction_api.trainedmodels.predict
+      body          = {input: {csvInstance: [text]}}.to_json
+
+      result = api_client.execute(
+        api_method: predict,
+        parameters: {'id' => model_id, 'project' => project_id},
+        body:       body,
+        headers:    HEADERS
+      )
+      data = JSON.parse(result.body)
+      Result.new(data)
+    end
+
+    def categories
+      output = metadata['dataDescription']['outputFeature']['text']
+      output.map { |category| category['value'] }
+    end
+
+    def confusion
+      metadata['modelDescription']['confusionMatrix']
+    end
+
+    def metadata
+      return @metadata if @metadata
+
+      authorize!
+
+      analyze = prediction_api.trainedmodels.analyze
+
+      result = api_client.execute(
+        api_method: analyze,
+        parameters: {'id' => model_id, 'project' => project_id},
+        headers:    HEADERS
+      )
+      @metadata = JSON.parse(result.body)
+    end
+
+    private
+
+    def authorize!
+      return unless api_client.authorization.access_token.nil?
+      api_client.authorization = authorizer.authorize
+    end
+
+    def prediction_api
+      api_client.discovered_api('prediction', configuration.api_version)
+    end
+
+    def authorizer
+      @authorizer ||= MachineClassifier::Authorizer.new(configuration)
+    end
+
+    def api_client
+      @api_client ||= Google::APIClient.new(
+        application_name: configuration.application_name,
+        application_version: configuration.application_version,
+      )
+    end
+
+    def project_id
+      configuration.project
+    end
+
+    def model_id
+      configuration.model
+    end
+  end
+end
+

data/lib/machine_classifier/configuration.rb

@@ -0,0 +1,27 @@
+module MachineClassifier
+  class Configuration
+    ATTRIBUTES = [
+      :api_version,
+      :application_name,
+      :application_version,
+      :developer_email,
+      :model,
+      :private_key,
+      :private_key_password,
+      :project
+    ]
+
+    ATTRIBUTES.each { |attribute| attr_accessor attribute }
+
+    def initialize
+      yield self if block_given?
+    end
+
+    def valid?
+      ATTRIBUTES.each do |attribute|
+        return false if self.send(attribute).nil? || self.send(attribute).empty?
+      end
+      true
+    end
+  end
+end

data/lib/machine_classifier/result.rb

@@ -0,0 +1,16 @@
+module MachineClassifier
+  class Result < Struct.new(:data)
+    def winner
+      data['outputLabel']
+    end
+
+    def success?
+      data['kind'] == 'prediction#output'
+    end
+
+    def error?
+      data.include?('error')
+    end
+  end
+end
+

data/lib/machine_classifier/version.rb

@@ -0,0 +1,3 @@
+module MachineClassifier
+  VERSION = "0.0.1"
+end

data/machine_classifier.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'machine_classifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'machine_classifier'
+  spec.version       = MachineClassifier::VERSION
+  spec.authors       = ['Joe Yates, Riccardo Lucatuorto']
+  spec.email         = ['joe.g.yates@gmail.com, gnuduncan@gmail.com']
+  spec.summary       = %q{A client for calling Machine learning classifiers.}
+  spec.description   = %q{Call GooglePrediction's classification API}
+  spec.homepage      = ''
+  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_runtime_dependency 'google-api-client'
+  
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/spec/machine_classifier/authorizer_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'google/api_client'
+
+describe MachineClassifier::Authorizer do
+  let(:configuration) do
+    double(
+      'MachineClassifier::Configuration',
+      private_key: private_key,
+      private_key_password: 'foo',
+      developer_email: 'dev@example.com'
+    )
+  end
+  let(:private_key) { 'BinaryPrivateData' }
+
+  subject do
+    MachineClassifier::Authorizer.new(configuration)
+  end
+
+  describe '#initialize' do
+    it 'expects a configuration' do
+      expect(subject.configuration).to eq(configuration)
+    end
+  end
+
+  describe '#authorize' do
+    let(:pkcs12_key) { 'pkcs12_key' }
+    let(:pkcs12) { double('PKCS12', key: pkcs12_key) }
+    let(:authorization) { double('Authorization') }
+    let(:service_account) { double('Google::APIClient::JWTAsserter', authorize: authorization) }
+    let(:prediction_url) { 'https://www.googleapis.com/auth/prediction' }
+
+    before do
+      allow(OpenSSL::PKCS12).to receive(:new).with(private_key, configuration.private_key_password).and_return(pkcs12)
+      allow(Google::APIClient::JWTAsserter).to receive(:new).with(configuration.developer_email, prediction_url, pkcs12_key).and_return(service_account)
+    end
+
+    it 'returns an authorization' do
+      expect(subject.authorize).to eq(authorization)
+    end
+  end
+end
+

data/spec/machine_classifier/client_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'json'
+
+describe MachineClassifier::Client do
+  let(:client_authorization) { double('ClientAuthorization') }
+  let(:api_client) { double('Google::APIClient', authorization: client_authorization) }
+  let(:authorizer) { double('MachineClassifier::Authorizer') }
+  let(:configuration) do
+    double(
+      'MachineClassifier::Configuration',
+      api_version: 'v1.6',
+      application_name: 'MachineClassifier',
+      application_version: 'v0.01',
+      developer_email: 'foo@bar.it',
+      model: 'name.of.model',
+      private_key: '123AF',
+      private_key_password: '123456',
+      project: 'project.id'
+    )
+  end
+  let(:prediction_settings) {}
+
+  subject { MachineClassifier::Client.new(configuration) }
+
+  before do
+    allow(MachineClassifier::Authorizer).to receive(:new).and_return(authorizer)
+    allow(Google::APIClient).to receive(:new).and_return(api_client)
+  end
+
+  describe '#initialize' do
+    it 'expects a configuration parameter' do
+      expect(subject.configuration).to eq(configuration)
+    end
+  end
+
+  describe '#call' do
+    let(:authorization) { double('Authorization') }
+    let(:authorizer) { double('MachineClassifier::Authorizer', authorize: authorization) }
+    let(:predict) { double('Predict') }
+    let(:prediction_resource) { double('Prediction', trainedmodels: double('Hosted', predict: predict)) }
+    let(:model) { 'name.of.model' }
+    let(:project) { 'project.id' }
+    let(:prediction_settings) do
+      double(
+        'google_prediction',
+        model: model,
+        project: project
+     )
+    end
+    let(:text) { 'This is great' }
+    let(:scores) do
+      {
+        'positive' => 0.87,
+        'neutral'  => 0.21,
+        'negative' => 0.02,
+      }
+    end
+
+    let(:output_multi) do
+      scores.map { |k, v| {'label' => k, 'score' => v} }
+    end
+
+    let(:prediction_url) do
+      "https://www.googleapis.com/prediction/v1.6/trainedmodels/#{model}/predict"
+    end
+    let(:prediction_result) do
+      {
+        'kind'        => 'prediction#output',
+        'id'          => 'sample.sentiment',
+        'selfLink'    => prediction_url,
+        'outputLabel' => 'positive',
+        'outputMulti' => output_multi
+      }
+    end
+    let(:body) { prediction_result.to_json }
+
+    let(:execute_result) { double('ApiCLient::Result', body: body) }
+    let(:result) { double('MachineClassifier::Result') }
+
+    before do
+      api_client.stub(:discovered_api).and_return(prediction_resource)
+      client_authorization.stub(:access_token).with().and_return(nil)
+      api_client.stub(:authorization=)
+      api_client.stub(:execute).and_return(execute_result)
+      allow(MachineClassifier::Result).to receive(:new).with(prediction_result).and_return(result)
+    end
+
+    before do
+      @result = subject.call(text)
+    end
+
+    it 'requests authorization' do
+      expect(authorizer).to have_received(:authorize).with()
+    end
+
+    it 'sets client authorization' do
+      expect(api_client).to have_received(:authorization=).with(authorization)
+    end
+
+    it 'loads the prediction API' do
+      expect(api_client).to have_received(:discovered_api).with('prediction', 'v1.6')
+    end
+
+    it 'loads the predict resource' do
+      expect(prediction_resource).to have_received(:trainedmodels).with()
+      expect(prediction_resource.trainedmodels).to have_received(:predict).with()
+    end
+
+    it 'calls the API' do
+      expected_body = {input: {csvInstance: [text]}}.to_json
+      expected_args = {
+        api_method: predict,
+        parameters: {'id' => model, 'project' => project},
+        body:       expected_body,
+        headers:    {'Content-Type' => 'application/json'},
+      }
+      expect(api_client).to have_received(:execute).with(expected_args)
+    end
+
+    it 'initializes a PredictionResult' do
+      expect(MachineClassifier::Result).to have_received(:new).with(prediction_result)
+    end
+
+    it 'returns the PredictionResult' do
+      expect(@result).to eq(result)
+    end
+  end
+end
+

data/spec/machine_classifier/configuration_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe MachineClassifier::Configuration do
+  describe '#initialize' do
+    it 'calls a supplied block' do
+      calls = 0
+      described_class.new { |config| calls += 1 }
+      expect(calls).to eq(1)
+    end
+
+    it 'passes itself to a block' do
+      config = described_class.new { |config| config.application_name = 'AAAA' }
+      expect(config.application_name).to eq('AAAA')
+    end
+
+    specify 'the block is optional' do
+      expect { described_class.new }.to_not raise_error
+    end
+  end
+
+  describe '#valid?' do
+    subject do
+      described_class.new do |conf|
+        conf.api_version = 'api_version'
+        conf.application_name = 'application_name'
+        conf.application_version = 'application_version'
+        conf.developer_email = 'developer_email'
+        conf.model = 'model'
+        conf.private_key = 'private_key'
+        conf.private_key_password = 'private_key_password'
+        conf.project = 'project'
+      end
+    end
+
+    context 'with all values set' do
+      it 'is true' do
+        expect(subject.valid?).to be_true
+      end
+    end
+
+    %w(application_name application_version).each do |attribute|
+      context "with #{attribute} missing" do
+        it "is false" do
+          method = "#{attribute}=".intern
+          subject.send(method, nil)
+          expect(subject.valid?).to be_false
+        end
+      end
+    end
+  end
+end

data/spec/machine_classifier/result_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe MachineClassifier::Result do
+  let(:data) do
+    {
+      'outputLabel' => 'foo',
+      'outputMulti' => [
+        {'label' => 'foo', 'score' => '0.4',},
+        {'label' => 'bar', 'score' => '0.3',},
+        {'label' => 'baz', 'score' => '0.3',},
+      ]
+    }
+  end
+
+  subject { MachineClassifier::Result.new(data) }
+
+  describe '#initialize' do
+    it 'expects a data parameter' do
+      expect(subject.data).to eq(data)
+    end
+  end
+
+  describe '#winner' do
+    it 'returns top category' do
+      expect(subject.winner).to eq('foo')
+    end
+  end
+
+  describe '#success?' do
+    it 'is false' do
+      expect(subject.success?).to be_false
+    end
+  end
+
+  describe '#error?' do
+    it 'is false' do
+      expect(subject.error?).to be_false
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require File.expand_path('../lib/machine_classifier', File.dirname(__FILE__))

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: machine_classifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joe Yates, Riccardo Lucatuorto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: 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'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Call GooglePrediction's classification API
+email:
+- joe.g.yates@gmail.com, gnuduncan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/machine_classifier.rb
+- lib/machine_classifier/authorizer.rb
+- lib/machine_classifier/client.rb
+- lib/machine_classifier/configuration.rb
+- lib/machine_classifier/result.rb
+- lib/machine_classifier/version.rb
+- machine_classifier.gemspec
+- spec/machine_classifier/authorizer_spec.rb
+- spec/machine_classifier/client_spec.rb
+- spec/machine_classifier/configuration_spec.rb
+- spec/machine_classifier/result_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: A client for calling Machine learning classifiers.
+test_files:
+- spec/machine_classifier/authorizer_spec.rb
+- spec/machine_classifier/client_spec.rb
+- spec/machine_classifier/configuration_spec.rb
+- spec/machine_classifier/result_spec.rb
+- spec/spec_helper.rb