gcf_ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a7b31b3606c2a025a1fb06636cef551266eeed086ca8a73c2730fac6b239b3f0
+  data.tar.gz: 5d37ff4a6b129cf3332b2f57b68a1ac30518a7103d0aa1b4fc3d75b8d8298a6f
+SHA512:
+  metadata.gz: d7ec83834c73014c10124848cac912b78d7b29a83a778064320bafe9d8fc08373fa0757b292f3df836fc911844057e6939d0602a9cdd09143700ef3f878a50ca
+  data.tar.gz: e3d5dc124795924244910ed961be382aa6ed92b8d99b6ff835ecc74d73296add19dde374d2205ebff56b74f8820c36182fe0915667cecb94fac96ff6d22033a9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gcf_ruby.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    gcf_ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
+    minitest (5.14.4)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rexml (3.2.5)
+    vcr (6.0.0)
+    webmock (3.12.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gcf_ruby!
+  minitest (>= 5.14)
+  rake (~> 12.0)
+  vcr (~> 6.0)
+  webmock (~> 3.12)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Flatlooker
+
+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,42 @@
+# GcfRuby : simple predictions with google cloud functions
+
+This gem allows interaction within ruby code with various APIs hosted in google cloud functions. It is primarly designed to predict results of machine learning models and works synchronously (for light predictions) or asynchronously (for heavier predictions). 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gcf_ruby'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gcf_ruby
+
+## Usage
+
+After installing the gem, complete the file in  `config/initializers/gcf_ruby.rb` with required `api_url` (for webhooks) and `api_bearer` for authentication.
+
+Two methods are available (as of 19/04/2021) : 
+
+- `predict(model_name, params)` which returns synchronously the result of the model with the corresponding model_name.
+- `predict_async` which returns asynchronously the result of the model. It requires a webhook url (set in `api_url`) on which the response will be sent.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Flatlooker/gcf_ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gcf_ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gcf_ruby.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gcf_ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gcf_ruby'
+  spec.version       = GcfRuby::VERSION
+  spec.authors       = ['Nicolas Goyet']
+  spec.email         = ['nicolas@flatlooker.com']
+
+  spec.summary       = 'This gem allows interaction within ruby code with various apis hosted in google cloud functions. Full list of available APIs here : https://github.com/Flatlooker/google_cloud_functions.'
+  spec.homepage      = 'https://github.com/Flatlooker/gcf_ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.add_development_dependency 'minitest', '>= 5.14'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+  spec.add_development_dependency 'webmock', '~> 3.12'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/Flatlooker/gcf_ruby'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/gcf_ruby.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# Ruby bindings
+require 'json'
+require 'net/http'
+
+# Resource and support classes
+require 'gcf_ruby/version'
+require 'gcf_ruby/errors'
+
+# Main class for prediction
+module GcfRuby
+  class << self
+    attr_accessor :configuration
+
+    def predict(model_name, params)
+      post(model_name, formatted_params(params))
+    end
+
+    def predict_async(model_name, params, webhook_url)
+      post(model_name, formatted_params(params), webhook_url)
+    end
+
+    private
+
+    def post(model_name, params, url = nil)
+      uri = URI.parse(GcfRuby.configuration.api_url)
+      query_params = { model: model_name }
+      query_params[:url] = url if url
+      uri.query = URI.encode_www_form(query_params)
+
+      req = Net::HTTP::Post.new(uri)
+      req['Authorization'] = "Bearer #{GcfRuby.configuration.api_bearer}"
+      req['Content-Type'] = 'application/json'
+
+      req.body =  params.to_json
+      generate_https = Net::HTTP.new(uri.host, uri.port)
+      generate_https.use_ssl = true
+
+      res = generate_https.request(req)
+      response = JSON.parse(res.body)
+
+      case res.code
+      when '400'
+        raise FailedValidationError, "Wrong inputs #{params} in model #{model_name}"
+      when '403'
+        raise AuthentificationError, 'Authorization error'
+      when '404'
+        raise WrongModelName, "Wrong model name #{model_name}"
+      when '405'
+        raise AsyncError, "#{model_name} should be called in an asynchronous manner"
+      when '500'
+        raise InternalServerError, 'Internal server error in api'
+      when '200'
+        # it's sync
+        response
+      when '202'
+        # it's ansync
+        true
+      else
+        raise UnhandledError, 'Cannot process error code'
+        false
+      end
+    end
+
+    def formatted_params(params)
+      { instances: params }
+    end
+  end
+
+  def self.configure(&block)
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :api_url
+    attr_accessor :api_bearer
+
+    def initialize
+      @api_url = 'default option'
+      @api_bearer = 'default option'
+    end
+  end
+end

data/lib/gcf_ruby/errors.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module GcfRuby
+  # GcfError is the base error from which all other more specific errors
+  class GcfError < StandardError
+    attr_accessor :message
+
+    def initialize(message = nil)
+      @message = message
+    end
+  end
+
+  # in case of 400
+  class FailedValidationError < GcfError
+  end
+
+  # in case of 403
+  class AuthentificationError < GcfError
+  end
+
+  # in case of 404
+  class WrongModelName < GcfError
+  end
+
+  # in case of 405
+  class AsyncError < GcfError
+  end
+
+  # in case of 500
+  class InternalServerError < GcfError
+  end
+
+  # in case of other errors
+  class UnhandledError < GcfError
+  end
+end

data/lib/gcf_ruby/version.rb

@@ -0,0 +1,3 @@
+module GcfRuby
+  VERSION = "0.1.0"
+end

data/lib/generators/gcf_ruby/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module GcfRuby
+  module Generators
+    # Install Generator inherits from Rails::Generator::Base
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../templates', __dir__)
+      desc 'Creates GcfRuby initializer for your application'
+
+      def copy_initializer
+        template 'gcf_initializer.rb', 'config/initializers/gcf_ruby.rb'
+
+        puts 'Install complete!'
+      end
+    end
+  end
+end

data/lib/generators/templates/gcf_ruby_initializer.rb

@@ -0,0 +1,4 @@
+GcfRuby.configure do |config|
+  config.api_url = 'your_gcf_url'
+  config.api_bearer = 'your_gcf_bearer'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: gcf_ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Goyet
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description:
+email:
+- nicolas@flatlooker.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gcf_ruby.gemspec
+- lib/gcf_ruby.rb
+- lib/gcf_ruby/errors.rb
+- lib/gcf_ruby/version.rb
+- lib/generators/gcf_ruby/install_generator.rb
+- lib/generators/templates/gcf_ruby_initializer.rb
+homepage: https://github.com/Flatlooker/gcf_ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Flatlooker/gcf_ruby
+  source_code_uri: https://github.com/Flatlooker/gcf_ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: 'This gem allows interaction within ruby code with various apis hosted in
+  google cloud functions. Full list of available APIs here : https://github.com/Flatlooker/google_cloud_functions.'
+test_files: []