constructorio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b12777162afb00778087eb0373df3a9c1afa2968
+  data.tar.gz: fd37598d4857e6353a863a739c842158a41893d0
+SHA512:
+  metadata.gz: 9538982e4bda8b25c18d963f17d33ab89b5e82d4eb06cf061e060049fdda1de1d4b1b04cf846ecabc45ddad92d3cbc4557ad7e95196cdcc5ff3d5389295077ba
+  data.tar.gz: 666f30871f099f656f8b536656196b7f615c6a728ea2357544e041422b7b1ca8fabf2a308720b2e624fadcf03df64b3486852b6d36747a13b9f3b855e06f9d10

data/.gitignore

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

data/.rock.yml

@@ -0,0 +1,10 @@
+runtime: ruby21
+
+env:
+  PATH: "${ROCK_PATH}/bin:${PATH}"
+
+build: |
+  rm -f ./bin/bundle
+  {{ parent }}
+
+run_web: bin/rails s

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Steven Lai
+
+MIT License
+
+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,50 @@
+# Constructor.io
+
+A Ruby client for the [Constructor.io API](http://constructor.io/docs).  Constructor.io provides a lightning-fast, typo-tolerant autocomplete service that ranks your users' queries by popularity to let them find what they're looking for as quickly as possible.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'constructorio'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself:
+
+    $ gem install customerio
+
+## Usage
+
+### Configuration for Rails
+
+Add an initializer file at config/initializers/constructor-io.rb with values from the [customer dashboard](http://constructor.io/dashboard):
+```
+ConstructorIO.configure do |config|
+  config.api_token = 'API_TOKEN'
+  config.autocomplete_key = 'AUTOCOMPLETE_KEY'
+end
+```
+To add autocomplete to a model:
+
+```
+class MyModel < ActiveRecord::Base
+  extend ConstructorIO
+  autocomplete(['attribute1', 'attribute2'])
+end
+
+```
+
+To attach an autocomplete dropdown to an input field, just insert this in your view:
+
+```
+<%= autocomplete(dom_id: 'id_of_input_field') %>
+```
+
+To import an existing data set into Constructor.io, you can use the rake task:
+
+```
+rake constructorio:import:model CLASS='MyModel'
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/constructorio.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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.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.homepage      = "http://constructor.io"
+  spec.license       = "MIT"
+
+  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_dependency "activerecord"
+  spec.add_dependency 'faraday', '~> 0.9', '>= 0.9.1'
+  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"
+end

data/lib/constructorio/configuration.rb

@@ -0,0 +1,5 @@
+module ConstructorIO
+  class Configuration
+    attr_accessor :api_token, :autocomplete_key, :api_url
+  end
+end

data/lib/constructorio/fields.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+
+module ConstructorIO
+  class Fields
+    include Singleton
+
+    attr_accessor :set
+
+    def initialize
+      @set = {}
+    end
+
+    def add(model, field)
+      @set[model] ||= {}
+      @set[model][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

@@ -0,0 +1,11 @@
+# usage: <%= autocomplete :dom_id => "search" %>
+
+module ConstructorIO
+  module Helper
+    def 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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,25 @@
+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/lib/constructorio/version.rb

@@ -0,0 +1,3 @@
+module ConstructorIO
+  VERSION = "1.0.0"
+end

data/lib/constructorio.rb

@@ -0,0 +1,75 @@
+require 'constructorio/version'
+require 'constructorio/configuration'
+require 'constructorio/helper'
+require 'constructorio/fields'
+require 'active_record'
+require 'faraday'
+require 'active_support/core_ext/string/output_safety'
+
+require 'constructorio/railtie' if defined?(Rails)
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+module ConstructorIO
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def autocomplete(fields, autocomplete_key = ConstructorIO.configuration.autocomplete_key)
+
+    fields.each do |field|
+      ConstructorIO::Fields.instance.add(self.model_name, field)
+    end
+
+    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)
+      end
+    end
+
+    before_destroy do |record|
+      fields.each do |field|
+        record.class.send(:delete_record, record[field.to_sym], autocomplete_key)
+      end
+    end
+  end
+
+  def add_record(value, autocomplete_key)
+    call_api("post", value, autocomplete_key)
+  end
+
+  def delete_record(value, autocomplete_key)
+    call_api("delete", value, autocomplete_key)
+  end
+
+  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}"}|
+    end
+    if response.status.to_s =~ /^2/
+      return nil
+    else
+      return response.status
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,15 @@
+require_relative 'test_helper'
+
+class ConfigurationTest < MiniTest::Test
+  def test_configure_api_token
+    assert_equal ConstructorIO.configuration.api_token, "example_api_token"
+  end
+
+  def test_configure_autocomplete_key
+    assert_equal ConstructorIO.configuration.autocomplete_key, "example_autocomplete_key"
+  end
+
+  def test_configure_api_url
+    assert_equal ConstructorIO.configuration.api_url, "http://example.constructor.io"
+  end
+end

data/test/constructorio_test.rb

@@ -0,0 +1,48 @@
+require_relative 'test_helper'
+
+class ConstructorIOTest < MiniTest::Test
+  def test_add_record
+    person = Person.new(
+      first_name: "Steven",
+      last_name: "Lai",
+      address: "New York"
+    )
+    Person.expects(:call_api).with("post", "Steven", "person_autocomplete_key")
+
+    assert person.save
+  end
+
+  def test_delete_record
+    Person.expects(:call_api).with("post", "Ronald", "person_autocomplete_key")
+    person = Person.create(
+      first_name: "Ronald",
+      last_name: "McDonald",
+      address: "Disneyland"
+    )
+
+    Person.expects(:call_api).with("delete", "Ronald", "person_autocomplete_key")
+    person.destroy
+  end
+
+  def test_add_record_without_key
+    person = PersonNoKey.new(
+      first_name: "Steven",
+      last_name: "Lai",
+      address: "New York"
+    )
+
+    PersonNoKey.expects(:call_api).with("post", "Lai", ConstructorIO.configuration.autocomplete_key)
+    assert person.save
+  end
+
+  def test_fields
+    Person.expects(:call_api).with("post", "Ronald", "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

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+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
+  extend ConstructorIO
+
+  autocomplete ['first_name'], "person_autocomplete_key"
+end
+
+class PersonNoKey < ActiveRecord::Base
+  self.table_name = 'people'
+
+  extend ConstructorIO
+
+  autocomplete ['last_name']
+end
+
+class FakeView
+  include ConstructorIO::Helper
+end

data/test/view_helper_test.rb

@@ -0,0 +1,11 @@
+require_relative 'test_helper'
+
+class ViewHelperTest < MiniTest::Test
+  def setup
+    @fakeview = FakeView.new
+  end
+
+  def test_autocomplete_html
+    assert_equal @fakeview.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

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: constructorio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steven Lai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-13 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !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
+    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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.
+email:
+- lai.steven@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rock.yml"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- constructorio.gemspec
+- lib/constructorio.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
+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: Ruby gem for Constructor.io
+test_files:
+- test/configuration_test.rb
+- test/constructorio_test.rb
+- test/test_helper.rb
+- test/view_helper_test.rb