simple_relevance 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+# Nothing so far.

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'httparty'
+
+group :development do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    multi_json (1.3.7)
+    multi_xml (0.5.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty
+  rspec

data/README.md

@@ -0,0 +1,4 @@
+SimpleRelevance-Ruby
+====================
+
+a simple Ruby wrapper for the SimpleRelevance api (simplerelevance.com) 

data/lib/simple_relevance.rb

@@ -0,0 +1,73 @@
+require 'rubygems'
+require 'httparty'
+
+# A Ruby API wrapper for SimpleRelevance
+# free to use and unlicensed
+# requires httparty
+
+# you can get an API key by signing up for SimpleRelevance on the site. Signup is free.
+# async: when you are done testing, set async=1. This will speed up API response times by a factor of 2 or 3.
+# predictions: this is the part of SimpleRelevance that eventually costs money to use. They will not be available right away, as our automated model builds happen nightly. Please get in touch during business hours (inquiries@simplerelevance.com) if you want us to build a model sooner.
+
+# documentation: note that documentation is available at simplerelevance.com/docs/api2
+
+# also, I have not used ruby in more than a year, so I apologize for creaky/ugly code. Anyway, all functionality has been tested.
+
+# BATCH MODE: note that converting to use batch mode is easy - all POST requests accept a list, as you can see, so simply modify the requests to take a list of hashes as input.
+
+class SimpleRelevance
+  include HTTParty
+
+  def initialize(key,async=0)
+    @api_key=key
+    @async=async
+  end
+
+  def _post(endpoint,post_data)
+    data = {:api_key=>@api_key,:async=>@async,:data=>post_data}
+    self.class.post("https://simplerelevance.com/api/v2/#{endpoint}",:body => JSON.dump(data), :options => {:headers => {'Content-Type'=>'application/json', :accept =>'application/json'}})
+  end
+
+  def _get(endpoint,get_data)
+    data = {:api_key=>@api_key,:async=>@async}
+    data.merge!(get_data)
+    puts data
+    self.class.get("https://simplerelevance.com/api/v2/#{endpoint}",:query => data)
+  end
+
+  def add_user(email,opts={})
+    zipcode = opts[:zipcode] || nil
+    user_id = opts[:user_id] || nil
+    data_dict = opts[:data_dict] || {}
+
+    payload = [{:email=>email,:zipcode=>zipcode,:user_id=>user_id,:data_dict=>data_dict}]
+    self._post('users/',payload)
+  end
+
+  def add_item(item_name,item_id,opts={})
+    item_type = opts[:item_type] || 'product'
+    data_dict = opts[:data_dict] || {}
+    variants = opts[:variants] || {}
+
+    payload = [{:item_name=>item_name,:item_id=>item_id,:item_type=>item_type,:data_dict=>data_dict,:variants=>variants}]
+    self._post('items/',payload)
+  end
+
+  # action_hook should be "clicks/" or "purchases/"
+  # takes: action_hook="purchases/",user_id=nil,item_id=nil,email=nil,item_name=nil,timestamp=nil,price=nil,zipcode=nil
+
+  def add_action(opts={})
+    action_hook = opts[:action_hook] || "purchases/"
+    opts.delete(:action_hook)
+    payload = [opts]
+    self._post(action_hook,payload)
+  end
+
+
+  def get_predictions(email,opts={})
+    opts[:email]=email
+    self._get('items/',opts)
+  end
+
+end
+

data/lib/simple_relevance/version.rb

@@ -0,0 +1,3 @@
+class SimpleRelevance
+  VERSION = '0.0.1'
+end

data/simple_relevance.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'simple_relevance/version'
+
+Gem::Specification.new do |s|
+  s.name = 'simple_relevance'
+  s.version = SimpleRelevance::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Declan Frye', 'Eli Albert']
+  s.email = 'deckleberryfrye@gmail.com'
+  s.summary = 'Ruby wrapper to SimpleRelevance API.'
+  s.description = 'Ruby wrapper to SimpleRelevance API. Allows you to upload data and to pull down recommendations.'
+
+  s.add_dependency 'httparty'
+  # s.add_development_dependency 'rspec'  # What does this do, exactly?
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files`.split($\)
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/tmp_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+sr = SimpleRelevance.new('KEY HERE',async=0)
+puts sr.add_user("iamnew@gmail.com",opts={:data_dict=>{:testingagain=>"2"}})
+puts sr.add_item("anotheritemtest",67,opts={:data_dict=>{:testattr=>"wahoo"}})
+puts sr.add_action({:action_hook=>"purchases",:email=>'anotherone23@gmail.com',:item_id=>66,:timestamp=>"12/24/2011 01:23:56"})
+puts sr.get_predictions('thisisforlater@gmail.com')

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: simple_relevance
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Declan Frye
+- Eli Albert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &73664280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *73664280
+description: Ruby wrapper to SimpleRelevance API. Allows you to upload data and to
+  pull down recommendations.
+email: deckleberryfrye@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/simple_relevance.rb
+- lib/simple_relevance/version.rb
+- simple_relevance.gemspec
+- spec/spec_helper.rb
+- spec/tmp_spec.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper to SimpleRelevance API.
+test_files: []