salesforce-einstein 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bcfa9e092608589daeec4da5d0483e7e87931c90a0e578570d6f6afdfdb316f3
+  data.tar.gz: bf5f59464f60b52c023c664d12806ec72c9844432ac41c63e47b4367fe87cdd5
+SHA512:
+  metadata.gz: 479bafec87791f8d9055bdbd3b53a5460c2dd576be89e369cb96c500203d17b8d95a18a1be937b58d2c82eb167d5e636a767ba9649e68f7d37af0cfeae0255df
+  data.tar.gz: 56b3690d3141eeef15ea6d0264e0a16aa860c186724a5e41b4b504fdf59e2f11f23a85b8ce644a2b6576e48bb69c338dcc4f025bd4b39779223ecf610a92a208

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.idea/
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.13.1

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salesforce-einstein.gemspec
+gemspec
+
+gem 'pry'
+gem 'pry-byebug'
+gem 'rubocop'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Makoto Tajitsu
+
+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,132 @@
+# Salesforce Einstein
+
+[![Build Status](https://travis-ci.org/tzmfreedom/salesforce-einstein.svg?branch=master)](https://travis-ci.org/tzmfreedom/salesforce-einstein)
+
+API Client for [Salesforce Einstein](https://einstein.ai).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'salesforce-einstein'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salesforce-einstein
+
+## Usage
+
+- Initialize Client
+```ruby
+client = Salesforce::Einstein::Client.new(cert: '/path/to/certificate', 
+                                          password: 'certificate password', 
+                                          email: 'einstein account email')
+```
+or
+```ruby
+client = Salesforce::Einstein::Client.new(private_key: '/path/to/private_key', 
+                                          password: 'private_key password', 
+                                          email: 'einstein account email')
+```
+
+- Prediction with Image URL
+```ruby
+client.predict_with_url 'url', 'modelId'
+```
+
+- Prediction with Image Base64 String
+```ruby
+client.predict_with_base64 'base64 string', 'modelId'
+```
+
+- Create a Dataset
+```ruby
+client.create_dataset 'name', 'labels'
+```
+
+- Get a Dataset
+```ruby
+client.get_dataset 'dataset_id'
+```
+
+- Get All Datasets
+```ruby
+client.get_all_datasets
+```
+
+- Delete a Dataset
+```ruby
+client.delete_dataset 'dataset_id'
+```
+
+- Create a Label
+```ruby
+client.create_label 'dataset_id', 'name'
+```
+
+- Get a Label
+```ruby
+client.get_label 'dataset_id', 'label_id'
+```
+
+- Create an Example
+```ruby
+client.create_example 'dataset_id', params
+```
+
+- Get an Example
+```ruby
+client.get_example 'dataset_id', 'example_id'
+```
+
+- Get All Examples
+```ruby
+client.get_all_example 'dataset_id'
+```
+
+- Delete an Example
+```ruby
+client.delete_example 'dataset_id', 'example_id'
+```
+
+- Train a Dataset
+```ruby
+client.train_dataset params
+```
+
+- Get Training Status
+```ruby
+client.get_training_status 'model_id'
+```
+
+- Get Model Metrics
+```ruby
+client.get_model_metrics 'model_id'
+```
+
+- Get All Models
+```ruby
+client.get_all_models 'dataset_id'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/tzmfreedom/salesforce-einstein.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'salesforce-einstein'
+
+# 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

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/lib/salesforce-einstein.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'salesforce/einstein/version'
+require 'salesforce/einstein/vision_client'
+require 'salesforce/einstein/language_client'

data/lib/salesforce/einstein/base.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'jwt'
+require 'net/https'
+require 'faraday'
+require 'securerandom'
+
+module Salesforce
+  module Einstein
+    class Base
+      BASE_URI = 'https://api.einstein.ai/v2'
+
+      attr_accessor :boundary, :email, :private_key, :access_token, :timeout
+
+      def initialize(cert: nil, private_key: nil, password: nil, email:, timeout: 3600)
+        if cert.nil? && private_key.nil?
+          raise ArgumentError, 'At least one parameter must be specified: cert or private_key'
+        end
+
+        if cert
+          cert_contents = File.read(File.expand_path(cert))
+          pkcs12 = OpenSSL::PKCS12.new(cert_contents, password)
+          @private_key = pkcs12.key
+        else
+          private_key_contents = File.read(File.expand_path(private_key))
+          @private_key = OpenSSL::PKey::RSA.new(private_key_contents, password)
+        end
+        @email = email
+        @boundary = SecureRandom.hex(10)
+        @timeout = 3600
+      end
+
+      def access_token
+        @token_info ||= get_access_token
+        @token_info['access_token']
+      end
+
+      def get_api_usage
+        get '/apiusage'
+      end
+
+      def delete_reflesh_token(token)
+        delete "/oauth2/token/#{token}"
+      end
+
+      private
+
+      def client
+        @client ||= Faraday.new do |conn|
+          conn.request :multipart
+          conn.request :url_encoded
+          conn.adapter :net_http
+        end
+      end
+
+      def get(path)
+        response = client.get do |req|
+          req.url "#{BASE_URI}#{path}"
+          req.headers['Authorization'] = "Bearer #{access_token}"
+        end
+        response ? JSON.parse(response.body) : nil
+      end
+
+      def post(path, params)
+        response = client.post do |req|
+          req.url "#{BASE_URI}#{path}"
+          req.headers['Content-Type'] = 'multipart/form-data'
+          req.headers['Authorization'] = "Bearer #{access_token}"
+          req.body = params
+        end
+        response ? JSON.parse(response.body) : nil
+      end
+
+      def delete(path)
+        response = client.delete do |req|
+          req.url "#{BASE_URI}#{path}"
+          req.headers['Content-Type'] = 'multipart/form-data'
+          req.headers['Authorization'] = "Bearer #{access_token}"
+        end
+        response ? JSON.parse(response.body) : nil
+      end
+
+      def get_access_token
+        jwt = JWT.encode({
+                           iss: 'developer.force.com',
+                           sub: email,
+                           aud: "#{BASE_URI}/oauth2/token",
+                           iat: Time.now.to_i,
+                           exp: Time.now.to_i + timeout
+                         }, private_key, 'RS256')
+
+        response = client.post do |req|
+          req.url "#{BASE_URI}/oauth2/token"
+          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+          req.body = {
+            grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+            assertion: jwt
+          }
+        end
+        response ? JSON.parse(response.body) : nil
+      end
+    end
+  end
+end

data/lib/salesforce/einstein/language_client.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'salesforce/einstein/base'
+
+module Salesforce
+  module Einstein
+    module V2
+      class LanguageClient < Salesforce::Einstein::Base
+        def predict_for_intent(document:, model_id: 'CommunitySentiment', num_results: nil, sample_id: nil)
+          post '/language/intent', document: document, modelId: model_id, numResults: num_results, sampleId: sample_id
+        end
+
+        def predict_for_sentiment(document:, model_id: 'CommunitySentiment', num_results: nil, sample_id: nil)
+          post '/language/sentiment', document: document, modelId: model_id, numResults: num_results, sampleId: sample_id
+        end
+
+        def create_dataset(name, labels, type = 'image')
+          post '/language/datasets', type: type, name: name, labels: labels
+        end
+
+        def create_dataset_from_file(sync: true, data: nil, name: nil, path: nil, type: 'text-intent')
+          params = { name: name, type: type }
+          params[:data] = data if data
+          params[:path] = path if path
+          post "/language/datasets/upload#{sync ? '/sync' : ''}", params
+        end
+
+        def all_datasets
+          get '/language/datasets'
+        end
+
+        def dataset(dataset_id)
+          get "/language/datasets/#{dataset_id}"
+        end
+
+        def delete_dataset(dataset_id)
+          delete "/language/datasets/#{dataset_id}"
+        end
+
+        def deletion_status(deletion_id)
+          get "/language/deletion/#{deletion_id}"
+        end
+
+        def create_label(dataset_id, name)
+          post "/language/datasets/#{dataset_id}/labels", name: name
+        end
+
+        def label(dataset_id, label_id)
+          get "/language/datasets/#{dataset_id}/labels/#{label_id}"
+        end
+
+        def create_example(dataset_id, params)
+          post "/language/datasets/#{dataset_id}/examples", params
+        end
+
+        def all_examples(dataset_id)
+          get "/language/datasets/#{dataset_id}/examples"
+        end
+
+        def all_examples_for_label(dataset_id, label_id)
+          get "/language/datasets/#{dataset_id}/examples?labelId=#{label_id}"
+        end
+
+        def delete_example(dataset_id, example_id)
+          delete "/language/datasets/#{dataset_id}/examples/#{example_id}"
+        end
+
+        def train_dataset(dataset_id:, name:)
+          post '/language/train', datasetId: dataset_id, name: name
+        end
+
+        def retain_dataset(params)
+          post '/language/retrain', params
+        end
+
+        def training_status(model_id)
+          get "/language/train/#{model_id}"
+        end
+
+        def model_metrics(model_id)
+          get "/language/models/#{model_id}"
+        end
+
+        def all_models(dataset_id)
+          get "/language/datasets/#{dataset_id}/models"
+        end
+      end
+    end
+
+    LanguageClient = V2::LanguageClient
+  end
+end

data/lib/salesforce/einstein/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Salesforce
+  module Einstein
+    VERSION = '0.0.1'
+  end
+end

data/lib/salesforce/einstein/vision_client.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'salesforce/einstein/base'
+
+module Salesforce
+  module Einstein
+    module V2
+      class VisionClient < Salesforce::Einstein::Base
+        def predict_with_url(url, modelId = 'GeneralImageClassifier')
+          post '/vision/predict', sampleLocation: url, modelId: modelId
+        end
+
+        # def predict_with_file path, modelId = 'GeneralImageClassifier'
+        #   post '/predict', {sampleContent: path, modelId: modelId}
+        # end
+
+        def predict_with_base64(base64_string, modelId = 'GeneralImageClassifier')
+          post '/vision/predict', sampleBase64Content: base64_string, modelId: modelId
+        end
+
+        def create_dataset(name, labels, type = 'image')
+          post '/vision/datasets', type: type, name: name, labels: labels
+        end
+
+        def all_datasets
+          get '/vision/datasets'
+        end
+
+        def dataset(dataset_id)
+          get "/vision/datasets/#{dataset_id}"
+        end
+
+        def delete_dataset(dataset_id)
+          delete "/vision/datasets/#{dataset_id}"
+        end
+
+        def deletion_status(deletion_id)
+          get "/vision/deletion/#{deletion_id}"
+        end
+
+        def create_label(dataset_id, name)
+          post "/vision/datasets/#{dataset_id}/labels", name: name
+        end
+
+        def label(dataset_id, label_id)
+          get "/vision/datasets/#{dataset_id}/labels/#{label_id}"
+        end
+
+        def create_example(dataset_id, params)
+          post "/vision/datasets/#{dataset_id}/examples", params
+        end
+
+        def all_examples(dataset_id)
+          get "/vision/datasets/#{dataset_id}/examples"
+        end
+
+        def all_examples_for_label(dataset_id, label_id)
+          get "/vision/datasets/#{dataset_id}/examples?labelId=#{label_id}"
+        end
+
+        def delete_example(dataset_id, example_id)
+          delete "/vision/datasets/#{dataset_id}/examples/#{example_id}"
+        end
+
+        def train_dataset(params)
+          post '/vision/train', params
+        end
+
+        def retain_dataset(params)
+          post '/vision/retrain', params
+        end
+
+        def training_status(model_id)
+          get "/vision/train/#{model_id}"
+        end
+
+        def model_metrics(model_id)
+          get "/vision/models/#{model_id}"
+        end
+
+        def all_models(dataset_id)
+          get "/datasets/#{dataset_id}/models"
+        end
+      end
+    end
+
+    VisionClient = V2::VisionClient
+  end
+end

data/salesforce-einstein.gemspec

@@ -0,0 +1,34 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce/einstein/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'salesforce-einstein'
+  spec.version       = ::Salesforce::Einstein::VERSION
+  spec.authors       = ['tzmfreedom']
+  spec.email         = ['makoto_tajitsu@hotmail.co.jp']
+
+  spec.summary       = 'API client for Salesforce Einstein.'
+  spec.description   = 'API client for Salesforce Einstein(https://einstein.ai/).'
+  spec.homepage      = 'https://github.com/tzmfreedom/salesforce-einstein'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'jwt', '~> 1.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: salesforce-einstein
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tzmfreedom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: API client for Salesforce Einstein(https://einstein.ai/).
+email:
+- makoto_tajitsu@hotmail.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/salesforce-einstein.rb
+- lib/salesforce/einstein/base.rb
+- lib/salesforce/einstein/language_client.rb
+- lib/salesforce/einstein/version.rb
+- lib/salesforce/einstein/vision_client.rb
+- salesforce-einstein.gemspec
+homepage: https://github.com/tzmfreedom/salesforce-einstein
+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.7.6
+signing_key: 
+specification_version: 4
+summary: API client for Salesforce Einstein.
+test_files: []