constructorio 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a44d85b592d503fee64cbf411daf318ab52fcfc9
-  data.tar.gz: 29aefce25803f2b066488c1550a047ee04ed0071
+  metadata.gz: 18db9093fcb9a5bd9ebcb0a13e74e0d828720695
+  data.tar.gz: cf0cf3d3c976f8face4928b86bb875c9174c9b64
 SHA512:
-  metadata.gz: 736e434f3feae53f9c501764871c7a96529efc39fdd124f557dd8fc55db98fe44cb25f6e03d31222497cb47d78739ce0173d6b861dd74683731c4b9e285f2898
-  data.tar.gz: 84df4cf7349f73b33f54cd0aa60f14a4f15b72d45630f442f1be4777550abb7b49a40fee1075abc5e41e2c84a6c1c821753b4ca9e801139bf06885045299abd0
+  metadata.gz: e7dde5ef1ee84ce2321d9caa2061e55b376ffdb425b4360c66f9b851b8d4bb49b357917fa53112a4f100a86acb19f42017391d783b63fdf6f30ebf6695ff3253
+  data.tar.gz: 005611dfe57cf1916995c0d8f16b00fbe1529d090b7bc371abd77f1df898120391421fe777eb0a71ba1aa72b366031cdc55c32d838dab732af18e775c722a206

data/.rock.yml

@@ -6,5 +6,3 @@ env:
 build: |
   rm -f ./bin/bundle
   {{ parent }}
-
-run_web: bin/rails s

data/constructorio.gemspec

@@ -6,10 +6,10 @@ require 'constructorio/version'
 Gem::Specification.new do |spec|
   spec.name          = "constructorio"
   spec.version       = ConstructorIO::VERSION
-  spec.authors       = ["Steven Lai"]
-  spec.email         = ["lai.steven@gmail.com"]
+  spec.authors       = ["Dan McCormick"]
+  spec.email         = ["dan@constructor.io"]
   spec.summary       = %q{Ruby gem for Constructor.io}
-  spec.description   = %q{Ruby gem for Constructor.io's autocomplete service. Enables Rails models to send updates to the Constructor.io API automatically, and provides a view helper to add autocomplete on any input.}
+  spec.description   = %q{Ruby gem for Constructor.io's autocomplete service.}
   spec.homepage      = "http://constructor.io"
   spec.license       = "MIT"
 
@@ -18,13 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord"
   spec.add_dependency 'faraday', '~> 0.9', '>= 0.9.0'
-  spec.add_dependency "activesupport", ">= 3.2"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'pry', '~> 0.10', '>= 0.10.1'
-  spec.add_development_dependency 'sqlite3', '~> 1.3', '>= 1.3.10'
   spec.add_development_dependency 'mocha', '~> 1.1', '>= 1.1.0'
-  spec.add_development_dependency "minitest", "~> 5.5.1"
+  spec.add_development_dependency 'minitest', '~> 5.5', '>= 5.5.1'
 end

data/lib/constructorio/client.rb

@@ -0,0 +1,58 @@
+require 'json'
+
+module ConstructorIO
+  class Client
+    def add(params)
+      call_api("item", "post", params)
+    end
+
+    def remove(params)
+      call_api("item", "delete", params)
+    end
+
+    def modify(params)
+      call_api("item", "put", params)
+    end
+
+    def track_search(params)
+      call_api("search", "post", params)
+    end
+
+    def track_click_through(params)
+      call_api("click_through", "post", params)
+    end
+
+    def track_conversion(params)
+      call_api("conversion", "post", params)
+    end
+
+    def verify
+      call_api("verify", "get")
+    end
+
+    private
+
+    def call_api(path, method, params)
+      api_token = ConstructorIO.configuration.api_token
+      api_url = ConstructorIO.configuration.api_url || "https://ac.constructor.io/"
+      autocomplete_key = ConstructorIO.configuration.autocomplete_key
+      @http_client ||= Faraday.new(url: api_url)
+      @http_client.basic_auth(api_token, '')
+
+      send_request(path, method, @http_client, params, autocomplete_key)
+    end
+
+    def send_request(path, method, http_client, params, autocomplete_key)
+      response = http_client.send(method) do |request|
+        request.url "/v1/#{path}?autocomplete_key=#{autocomplete_key}"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = params.to_json
+      end
+      if response.status.to_s =~ /^2/
+        return nil
+      else
+        return response.status
+      end
+    end
+  end
+end

data/lib/constructorio/version.rb

@@ -1,3 +1,3 @@
 module ConstructorIO
-  VERSION = "1.0.4"
+  VERSION = "2.0.0"
 end

data/lib/constructorio.rb

@@ -1,25 +1,15 @@
 require 'constructorio/version'
 require 'constructorio/configuration'
-require 'constructorio/helper'
-require 'constructorio/fields'
-require 'active_record'
+require 'constructorio/client'
 require 'faraday'
-require 'active_support/core_ext/string/output_safety'
-
-require 'constructorio/railtie' if defined?(Rails)
 
 begin
   require 'pry'
 rescue LoadError
 end
 
-class MissingItemName < StandardError; end
-
 module ConstructorIO
-
-  class << self
-    attr_accessor :configuration
-  end
+  attr_accessor :configuration
 
   def self.configuration
     @configuration ||= Configuration.new
@@ -28,95 +18,4 @@ module ConstructorIO
   def self.configure
     yield(configuration)
   end
-
-  # This injects the methods on the included hook
-  def self.included base
-    base.send :include, InstanceMethods
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    # "fields" is expected to be an array of strings or an array of hashes, like:
-    # "product_name", "description"
-    # - or -
-    # { 'attribute' => 'product_name', 'metadata' => { metadata_one => ->{ something_dynamic }} }
-    def constructorio_autocomplete(fields, autocomplete_key = ConstructorIO.configuration.autocomplete_key)
-      # All fields require an attribute
-      field_names = fields.map { |f| f.is_a?(String) ? f : f['attribute'] }
-      raise MissingItemName if field_names.include? nil
-
-      field_names.each do |field|
-        ConstructorIO::Fields.instance.add(self.model_name, field)
-      end
-
-      # transform the data
-      transformed = {}
-      fields.each do |field|
-        if field.is_a?(String)
-          transformed[field] = {}
-        else
-          transformed[field['attribute']] = field['metadata']
-        end
-      end
-
-      after_save do |record|
-        updated_fields = record.changed.select { |c| field_names.include? c }
-        updated_fields.each do |field|
-          record.send(:constructorio_add_record, record[field.to_sym], transformed[field], autocomplete_key)
-        end
-      end
-
-      before_destroy do |record|
-        field_names.each do |field|
-          record.send(:constructorio_delete_record, record[field.to_sym], transformed[field], autocomplete_key)
-        end
-      end
-    end
-  end
-
-  module InstanceMethods
-    def constructorio_add_record(value, metadata = {}, autocomplete_key)
-      constructorio_call_api("post", value, metadata, autocomplete_key)
-    end
-
-    def constructorio_delete_record(value, metadata = {}, autocomplete_key)
-      constructorio_call_api("delete", value, metadata, autocomplete_key)
-    end
-
-    private
-
-    def constructorio_make_request_body(value, metadata)
-      request_body = { "item_name" => "#{value}" }
-      unless metadata.empty?
-        metadata.each do |k, v|
-          v = instance_exec(&v) if v.is_a? Proc
-          request_body[k] = v
-        end
-      end
-      request_body
-    end
-
-    def constructorio_call_api(method, value, metadata, autocomplete_key)
-      api_token = ConstructorIO.configuration.api_token
-      api_url = ConstructorIO.configuration.api_url || "https://ac.constructor.io/"
-      @http_client ||= Faraday.new(url: api_url)
-      @http_client.basic_auth(api_token, '')
-
-      request_body = constructorio_make_request_body(value, metadata)
-      constructorio_send_request(method, @http_client, request_body, autocomplete_key)
-    end
-
-    def constructorio_send_request(method, http_client, request_body, autocomplete_key)
-      response = http_client.send(method) do |request|
-        request.url "/v1/item?autocomplete_key=#{autocomplete_key}"
-        request.headers['Content-Type'] = 'application/json'
-        request.body = request_body.to_json
-      end
-      if response.status.to_s =~ /^2/
-        return nil
-      else
-        return response.status
-      end
-    end
-  end
 end

data/test/constructorio_test.rb

@@ -1,106 +1,50 @@
 require_relative 'test_helper'
 
 class ConstructorIOTest < MiniTest::Test
-  def test_add_record_makes_request
-    person = Person.new(
-      first_name: "Steven",
-      last_name: "Lai",
-      address: "New York"
+  def test_add_record_calls_post
+    c = ConstructorIO::Client.new
+    c.expects(:call_api).with(
+      "item",
+      "post",
+      { item_name: "power drill" }
     )
 
-    person.stubs(:constructorio_send_request)
-
-    person.expects(:constructorio_make_request_body)
-    assert person.save
-  end
-
-  def test_add_simple_record_makes_request
-    person = PersonSimple.new(
-      first_name: "Steven",
-      last_name: "Lai",
-      address: "New York"
-    )
-
-    person.stubs(:constructorio_send_request)
-
-    person.expects(:constructorio_make_request_body)
-    assert person.save
-  end
-
-  def test_add_record_accepts_procs
-    person = Person.new(
-      first_name: "Steven",
-      last_name: "Lai",
-      address: "New York"
-    )
-
-    person.expects(:constructorio_send_request).with(
-      'post',
-      instance_of(Faraday::Connection),
-      {'item_name' => 'Steven', 'test_metadata' => 'test_values', 'test_proc' => 'NEW YORK'},
-      'person_autocomplete_key'
-    )
-    assert person.save
-  end
-
-  def test_add_simple_record_accepts_procs
-    person = PersonSimple.new(
-      first_name: "Steven",
-      last_name: "Lai",
-      address: "New York"
-    )
-
-    person.expects(:constructorio_send_request).with(
-      'post',
-      instance_of(Faraday::Connection),
-      {'item_name' => 'Steven'},
-      'example_autocomplete_key'
-    )
-    assert person.save
+    c.add( { item_name: "power drill" } )
   end
 
   def test_add_record_sends_request
-    person = Person.new(
-      first_name: "Steven",
-      last_name: "Lai",
-      address: "New York"
+    c = ConstructorIO::Client.new
+    c.expects(:send_request).with(
+      "item",
+      "post",
+      instance_of(Faraday::Connection),
+      { item_name: "power drill" },
+      "example_autocomplete_key"
     )
 
-    person.expects(:constructorio_send_request)
-    assert person.save
+    c.add( { item_name: "power drill" } )
   end
 
-  def test_delete_record_makes_request
-    Person.any_instance.stubs(:constructorio_call_api)
-    person = Person.create(
-      first_name: "Ronald",
-      last_name: "McDonald",
-      address: "Disneyland"
+  def test_remove_record_calls_delete
+    c = ConstructorIO::Client.new
+    c.expects(:call_api).with(
+      "item",
+      "delete",
+      { item_name: "power drill" }
     )
 
-    person.expects(:constructorio_call_api).with("delete", "Ronald", has_entry('test_proc', instance_of(Proc)),"person_autocomplete_key")
-    person.destroy
+    c.remove( { item_name: "power drill" } )
   end
 
-  def test_add_record_without_key_uses_default_key
-    person = PersonNoKey.new(
-      first_name: "Steven",
-      last_name: "Lai",
-      address: "New York"
+  def test_modify_record_calls_put
+    c = ConstructorIO::Client.new
+    c.expects(:call_api).with(
+      "item",
+      "put",
+      { item_name: "power drill" }
     )
 
-    person.expects(:constructorio_call_api).with("post", "Lai", anything, ConstructorIO.configuration.autocomplete_key)
-    assert person.save
+    c.modify( { item_name: "power drill" } )
   end
 
-  def test_fields_are_tracked
-    Person.any_instance.expects(:constructorio_call_api).with("post", "Ronald", anything, "person_autocomplete_key")
-    person = Person.create(
-      first_name: "Ronald",
-      last_name: "McDonald",
-      address: "Disneyland"
-    )
-
-    assert_equal ConstructorIO::Fields.instance.list('Person'), ["first_name"]
-  end
 end

data/test/test_helper.rb

@@ -3,49 +3,8 @@ require 'minitest/unit'
 require 'mocha/mini_test'
 require_relative '../lib/constructorio'
 
-
-ActiveRecord::Base.establish_connection(
-  adapter: 'sqlite3',
-  database: ':memory:'
-)
-
-ActiveRecord::Schema.define do
-  create_table :people, force: true do |t|
-    t.string :first_name
-    t.string :last_name
-    t.string :address
-  end
-end
-
 ConstructorIO.configure do |config|
   config.api_token = "example_api_token"
   config.autocomplete_key = "example_autocomplete_key"
   config.api_url = "http://example.constructor.io"
 end
-
-class Person < ActiveRecord::Base
-  include ConstructorIO
-  constructorio_autocomplete [{
-    'attribute' => 'first_name',
-    'metadata' => {
-      'test_metadata' => 'test_values',
-      'test_proc' => ->{ self.address.upcase }
-    }
-  }], "person_autocomplete_key"
-end
-
-class PersonSimple < ActiveRecord::Base
-  self.table_name = 'people'
-  include ConstructorIO
-  constructorio_autocomplete [ 'first_name' ]
-end
-
-class PersonNoKey < ActiveRecord::Base
-  self.table_name = 'people'
-  include ConstructorIO
-  constructorio_autocomplete [{'attribute' => 'last_name'}]
-end
-
-class FakeView
-  include ConstructorIO::Helper
-end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: constructorio
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
-- Steven Lai
+- Dan McCormick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-16 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  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: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,26 +78,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.1
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.10
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.10
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +103,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.5.1
   type: :development
@@ -158,13 +113,14 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.5.1
-description: Ruby gem for Constructor.io's autocomplete service. Enables Rails models
-  to send updates to the Constructor.io API automatically, and provides a view helper
-  to add autocomplete on any input.
+description: Ruby gem for Constructor.io's autocomplete service.
 email:
-- lai.steven@gmail.com
+- dan@constructor.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -178,16 +134,12 @@ files:
 - Rakefile
 - constructorio.gemspec
 - lib/constructorio.rb
+- lib/constructorio/client.rb
 - lib/constructorio/configuration.rb
-- lib/constructorio/fields.rb
-- lib/constructorio/helper.rb
-- lib/constructorio/railtie.rb
-- lib/constructorio/tasks/import.rake
 - lib/constructorio/version.rb
 - test/configuration_test.rb
 - test/constructorio_test.rb
 - test/test_helper.rb
-- test/view_helper_test.rb
 homepage: http://constructor.io
 licenses:
 - MIT
@@ -216,4 +168,3 @@ test_files:
 - test/configuration_test.rb
 - test/constructorio_test.rb
 - test/test_helper.rb
-- test/view_helper_test.rb

data/lib/constructorio/fields.rb

@@ -1,27 +0,0 @@
-require 'singleton'
-
-module ConstructorIO
-  class Fields
-    include Singleton
-
-    attr_accessor :set
-
-    def initialize
-      @set = {}
-    end
-
-    def add(model_name, field)
-      @set[model_name] ||= {}
-      @set[model_name][field] = 1
-    end
-
-    def list(model_name)
-      if @set[model_name].is_a?(Hash)
-        @set[model_name].keys
-      else
-        []
-      end
-    end
-  end
-end
-

data/lib/constructorio/helper.rb

@@ -1,11 +0,0 @@
-# usage: <%= autocomplete :dom_id => "search" %>
-
-module ConstructorIO
-  module Helper
-    def constructorio_autocomplete(options = {})
-      result = %Q|<script type="text/javascript" src="//cnstrc.com/js/ac.js"></script>\n|
-      result += %Q|<script>$(document).ready(function(){ $('##{options[:dom_id]}').constructorAutocomplete({ key: '#{ConstructorIO.configuration.autocomplete_key}' }); })</script>|
-      return result.html_safe
-    end
-  end
-end

data/lib/constructorio/railtie.rb

@@ -1,15 +0,0 @@
-require 'rails'
-
-module ConstructorIO
-  class Railtie < Rails::Railtie
-    initializer 'constructorio.action_view' do
-      ActiveSupport.on_load(:action_view) do
-        include ConstructorIO::Helper
-      end
-    end
-
-    rake_tasks do
-      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
-    end
-  end
-end

data/lib/constructorio/tasks/import.rake

@@ -1,25 +0,0 @@
-namespace :constructorio do
-  import_model_desc = <<-DESC.gsub(/    /, '')
-    Import data from your model (pass name as CLASS environment variable).
-
-    $ rake environment constructorio:import:model CLASS='MyModel'
-  DESC
-
-  task :import => 'import:model'
-
-  namespace :import do
-    desc import_model_desc
-
-    task :model do
-      klass  = eval(ENV['CLASS'].to_s)
-      fields = ConstructorIO::Fields.instance.list(klass.model_name)
-      if fields.any?
-        klass.all.each do |record|
-          fields.each do |field|
-            klass.add_record(record[field.to_sym], ConstructorIO.configuration.autocomplete_key)
-          end
-        end
-      end
-    end
-  end
-end

data/test/view_helper_test.rb

@@ -1,11 +0,0 @@
-require_relative 'test_helper'
-
-class ViewHelperTest < MiniTest::Test
-  def setup
-    @fakeview = FakeView.new
-  end
-
-  def test_autocomplete_html
-    assert_equal @fakeview.constructorio_autocomplete(dom_id: 'a'), "<script type=\"text/javascript\" src=\"//cnstrc.com/js/ac.js\"></script>\n<script>$(document).ready(function(){ $('#a').constructorAutocomplete({ key: 'example_autocomplete_key' }); })</script>"
-  end
-end