fuzzy_io 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9bd906208239585a0f3daa3f09c14fca4f113dcd
+  data.tar.gz: 52855e67f6913c3d7525f167991aa555ceacca59
+SHA512:
+  metadata.gz: 2070056fb761a457f486fd17965483b1237b1324577dc166e4b412020a48c77c7d86fdbb1a8e755017504aff9ec0e097f4072406c1a80ddd3fb38e6befe9384b
+  data.tar.gz: ec9a9a6bac274e6fc520b286d4044727fd31f50aa0aec188824d3dac9ec55ce77391d4aea19bb9d99ae636206ae4ae621b2dbaf26395351865f2c9b85d3af0ca

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,104 @@
+# FuzzyIo
+
+Client library for the fuzzy.io RESTful API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fuzzy_io'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fuzzy_io
+
+## Usage
+
+This gem handles the most basic usage of Fuzzy.io.
+
+```ruby
+# Require the module
+
+require 'fuzzy_io'
+
+# Your API key (get one from https://fuzzy.io/)
+
+API_KEY = 'YOUR_API_KEY_HERE'
+
+# Create an account object
+
+acct = FuzzyIo::Account.new API_KEY
+
+# ID of the agent you want to call; get it from https://fuzzy.io/
+
+AGENT_ID = 'AGENT_ID_HERE'
+
+# Inputs; map of string or symbol to numbers
+
+inputs = {
+  input1: 10,
+  input2: 30
+}
+
+# Ask the agent to evaluate the inputs; returns two values!
+
+outputs, evaluation_id = acct.evaluate AGENT_ID, inputs
+
+# Outputs is all the outputs
+
+puts outputs["output1"]
+
+# An opaque ID for the evaluation
+
+puts evaluation_id
+
+# For feedback, provide a performance metric
+
+performance = {
+  performance1: 3
+}
+
+fb = acct.feedback evaluation_id, performance
+```
+
+### FuzzyIo::Account
+
+Class representing a single account; you can use it to do evaluations and give
+feedback.
+
+#### initialize(key)
+
+Takes a string representing the API key. You can get the key on the top of your
+account page on https://fuzzy.io/ .
+
+#### evaluate(agent_id, inputs)
+
+Takes a string representing the agent ID, and a hash mapping input names
+(strings or symbols) to numbers.
+
+Response is two values (2!) -- a map of the output names to numbers, and a
+string for the evaluation ID.
+
+#### feedback(evaluation_id, peformance)
+
+Takes a string for the evaluation ID, and a hash mapping performance metrics to
+numbers. You can provide more than one metric.
+
+The metrics will be optimized to increase -- so, number of clicks,
+profit on sale, etc. If you have a number that will go towards negative infinity,
+multiple it by -1. If you have a number that will go toward zero, give its
+inverse (1/x).
+
+## Contributing
+
+1. Fork it ( https://github.com/fuzzy-io/ruby/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,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end

data/fuzzy_io.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fuzzy_io/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fuzzy_io"
+  spec.version       = FuzzyIo::VERSION
+  spec.authors       = ["Evan Prodromou"]
+  spec.email         = ["evan@fuzzy.io"]
+  spec.summary       = %q{Interface to the fuzzy.io REST API}
+#  spec.description   = %q{}
+  spec.homepage      = "https://fuzzy.io/docs#ruby"
+  spec.license       = "Apache-2.0"
+
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fuzzy_io/version.rb

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

data/lib/fuzzy_io.rb

@@ -0,0 +1,60 @@
+require 'fuzzy_io/version'
+require 'net/http'
+require 'json'
+
+API_ROOT = "https://api.fuzzy.io"
+
+module FuzzyIo
+
+  class Account
+
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def evaluate(agent_id, inputs)
+      uri = URI(API_ROOT + "/agent/" + agent_id)
+      body = inputs.to_json
+      headers = {
+        'Content-Type' => 'application/json',
+        'Authorization' => 'Bearer ' + @key,
+        'Content-Length' => body.length.to_s
+      }
+      req = Net::HTTP::Post.new(uri, initheader = headers)
+      req.body = body
+      http = Net::HTTP.start(uri.hostname, uri.port, opt={use_ssl: (uri.scheme == "https")})
+      res = http.request(req)
+      if res.is_a?(Net::HTTPSuccess)
+        id = res['X-Evaluation-ID']
+        outputs = JSON.parse res.body
+        return outputs, id
+      else
+        raise res
+      end
+    end
+
+    def feedback(evaluation_id, performance)
+      uri = URI(API_ROOT + "/evaluation/" + evaluation_id + "/feedback")
+      body = performance.to_json
+      headers = {
+        'Content-Type' => 'application/json',
+        'Authorization' => 'Bearer ' + @key,
+        'Content-Length' => body.length.to_s
+      }
+      req = Net::HTTP::Post.new(uri, initheader = headers)
+      req.body = body
+      http = Net::HTTP.start(uri.hostname, uri.port, opt={use_ssl: (uri.scheme == "https")})
+      res = http.request(req)
+      if res.is_a?(Net::HTTPSuccess)
+        fb = JSON.parse res.body
+        return fb
+      else
+        raise res
+      end
+    end
+
+  end
+
+end

data/test/test_fuzzy_io.rb

@@ -0,0 +1,33 @@
+require 'minitest/autorun'
+
+require 'fuzzy_io'
+require 'fuzzy_io/version'
+
+API_KEY = ENV["FUZZY_IO_API_KEY"]
+AGENT_ID = ENV["FUZZY_IO_AGENT_ID"]
+
+class TestFuzzyIo < MiniTest::Unit::TestCase
+
+  def setup
+    @account = FuzzyIo::Account.new API_KEY
+  end
+
+  def test_api_key_property
+    assert_equal @account.key, API_KEY
+  end
+
+  def test_has_evaluate_method
+    inputs = {input1: 10}
+    outputs, evaluation_id = @account.evaluate AGENT_ID, inputs
+    refute_nil evaluation_id
+    assert_in_delta outputs["output1"], 8.8, 0.1
+  end
+
+  def test_feedback_method
+    inputs = {input1: 10}
+    outputs, evaluation_id = @account.evaluate AGENT_ID, inputs
+    feedback = {performance: 3}
+    fb = @account.feedback evaluation_id, feedback
+    refute_nil feedback
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: fuzzy_io
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evan Prodromou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: 
+email:
+- evan@fuzzy.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fuzzy_io.gemspec
+- lib/fuzzy_io.rb
+- lib/fuzzy_io/version.rb
+- test/test_fuzzy_io.rb
+homepage: https://fuzzy.io/docs#ruby
+licenses:
+- Apache-2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Interface to the fuzzy.io REST API
+test_files:
+- test/test_fuzzy_io.rb