constructorio 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40e32ccf33eeef2ae06b3df8d5dabf6502afc172
-  data.tar.gz: 7f3388a3313802ff44c90bd9134cfdec55b47295
+  metadata.gz: 0afa62571df5734cb0bec7f26976b1ff8b4ed039
+  data.tar.gz: 8bfbffbaee6ff520ec59a6d5208ef3fd5dba5b7d
 SHA512:
-  metadata.gz: 746be9380a15969bf924459873cf6f51818e4ccce284339e32488b049a0f6e0a93562d7c082cbbc8d2dc10a5a05579a6168288e56c08eff93070f2096f0096e9
-  data.tar.gz: 3d2e4caa400045ee3da00cd9a0271ee42f285ad3e88fd5b40aacfafc494459a2c760f40c8183f030208f6476546d95bc2cb8c1cc940578a016e2f2b17da5f6df
+  metadata.gz: 479bdfc0a8a29dfbcb15254af5f36a88438db4763f53d5ccbaa3a67cd5af066ac9f673483b154e36e788b9f47daa4f3e093b36a4dece7e899dd0581804f9db8b
+  data.tar.gz: cfeca1527e5c9f1d543e38a514e41e02310c5a181d9e11c29effcbd288d1a68fb8c2a85468317ebf7efe2fcb8778927518c3a99fb893069b600fd3e8d5ab29b6

data/README.md

@@ -31,7 +31,7 @@ To add autocomplete to a model:
 
 ```
 class MyModel < ActiveRecord::Base
-  extend ConstructorIO
+  include ConstructorIO
   autocomplete(['attribute1', 'attribute2'])
 end
 

data/lib/constructorio.rb

@@ -13,7 +13,10 @@ begin
 rescue LoadError
 end
 
+class MissingItemName < StandardError; end
+
 module ConstructorIO
+
   class << self
     attr_accessor :configuration
   end
@@ -26,50 +29,94 @@ module ConstructorIO
     yield(configuration)
   end
 
-  def autocomplete(fields, autocomplete_key = ConstructorIO.configuration.autocomplete_key)
+  # This injects the methods on the included hook
+  def self.included base
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+  end
 
-    fields.each do |field|
-      ConstructorIO::Fields.instance.add(self.model_name, field)
-    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 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
 
-    after_save do |record|
-      updated_fields = record.changed.select { |c| fields.include? c }
-      updated_fields.each do |field|
-        record.class.send(:add_record, record[field.to_sym], autocomplete_key)
+      field_names.each do |field|
+        ConstructorIO::Fields.instance.add(self.model_name, field)
       end
-    end
 
-    before_destroy do |record|
+      # transform the data
+      transformed = {}
       fields.each do |field|
-        record.class.send(:delete_record, record[field.to_sym], autocomplete_key)
+        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
 
-  def add_record(value, autocomplete_key)
-    call_api("post", value, autocomplete_key)
-  end
+  module InstanceMethods
+    def constructorio_add_record(value, metadata = {}, autocomplete_key)
+      constructorio_call_api("post", value, metadata, autocomplete_key)
+    end
 
-  def delete_record(value, autocomplete_key)
-    call_api("delete", value, 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, '')
 
-  private
-
-  def call_api(method, value, 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, '')
-    response = @http_client.send(method) do |request|
-      request.url "/v1/item?autocomplete_key=#{autocomplete_key}"
-      request.headers['Content-Type'] = 'application/json'
-      request.body = %Q|{"item_name": "#{value}"}|
+      request_body = constructorio_make_request_body(value, metadata)
+      constructorio_send_request(method, @http_client, request_body, autocomplete_key)
     end
-    if response.status.to_s =~ /^2/
-      return nil
-    else
-      return response.status
+
+    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/lib/constructorio/fields.rb

@@ -10,9 +10,9 @@ module ConstructorIO
       @set = {}
     end
 
-    def add(model, field)
-      @set[model] ||= {}
-      @set[model][field] = 1
+    def add(model_name, field)
+      @set[model_name] ||= {}
+      @set[model_name][field] = 1
     end
 
     def list(model_name)

data/lib/constructorio/version.rb

@@ -1,3 +1,3 @@
 module ConstructorIO
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

data/test/constructorio_test.rb

@@ -1,48 +1,106 @@
 require_relative 'test_helper'
 
 class ConstructorIOTest < MiniTest::Test
-  def test_add_record
+  def test_add_record_makes_request
     person = Person.new(
       first_name: "Steven",
       last_name: "Lai",
       address: "New York"
     )
-    Person.expects(:call_api).with("post", "Steven", "person_autocomplete_key")
 
+    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
+  end
+
+  def test_add_record_sends_request
+    person = Person.new(
+      first_name: "Steven",
+      last_name: "Lai",
+      address: "New York"
+    )
+
+    person.expects(:constructorio_send_request)
     assert person.save
   end
 
-  def test_delete_record
-    Person.expects(:call_api).with("post", "Ronald", "person_autocomplete_key")
+  def test_delete_record_makes_request
+    Person.any_instance.stubs(:constructorio_call_api)
     person = Person.create(
       first_name: "Ronald",
       last_name: "McDonald",
       address: "Disneyland"
     )
 
-    Person.expects(:call_api).with("delete", "Ronald", "person_autocomplete_key")
+    person.expects(:constructorio_call_api).with("delete", "Ronald", has_entry('test_proc', instance_of(Proc)),"person_autocomplete_key")
     person.destroy
   end
 
-  def test_add_record_without_key
+  def test_add_record_without_key_uses_default_key
     person = PersonNoKey.new(
       first_name: "Steven",
       last_name: "Lai",
       address: "New York"
     )
 
-    PersonNoKey.expects(:call_api).with("post", "Lai", ConstructorIO.configuration.autocomplete_key)
+    person.expects(:constructorio_call_api).with("post", "Lai", anything, ConstructorIO.configuration.autocomplete_key)
     assert person.save
   end
 
-  def test_fields
-    Person.expects(:call_api).with("post", "Ronald", "person_autocomplete_key")
+  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"]
+    assert_equal ConstructorIO::Fields.instance.list('Person'), ["first_name"]
   end
 end

data/test/test_helper.rb

@@ -24,17 +24,26 @@ ConstructorIO.configure do |config|
 end
 
 class Person < ActiveRecord::Base
-  extend ConstructorIO
+  include ConstructorIO
+  autocomplete [{
+    'attribute' => 'first_name',
+    'metadata' => {
+      'test_metadata' => 'test_values',
+      'test_proc' => ->{ self.address.upcase }
+    }
+  }], "person_autocomplete_key"
+end
 
-  autocomplete ['first_name'], "person_autocomplete_key"
+class PersonSimple < ActiveRecord::Base
+  self.table_name = 'people'
+  include ConstructorIO
+  autocomplete [ 'first_name' ]
 end
 
 class PersonNoKey < ActiveRecord::Base
   self.table_name = 'people'
-
-  extend ConstructorIO
-
-  autocomplete ['last_name']
+  include ConstructorIO
+  autocomplete [{'attribute' => 'last_name'}]
 end
 
 class FakeView

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constructorio
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Steven Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord