multicolor 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faa681abadf3aefc66674b7ade04ec7f848704d8
+  data.tar.gz: 6574464e78742045a2ed80f96d2c4928d3f2b01e
+SHA512:
+  metadata.gz: 8de82e40093c6a0f0a0a978b8f014fb8f211f152968a9a7f5251e4433545c0cd122c27d002e1aa33f3469940d2dc2ccc905cb58d425f6f291db1017ca0692168
+  data.tar.gz: afeb3c2e3650a7ee13d16e641beac41daea7a7b73c248ee16f47d666215c91815a8dc687e2fc2b491f8c61ad045c687641d70138408e8bb54124e2de2b8bd951

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Apartment Therapy LLC
+
+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,130 @@
+# Multicolor
+
+An opinionated library to ease usage of TinEye's fabulous MulticolorEngine
+http://services.tineye.com/MulticolorEngine.
+
+Full API documentation available at http://multicolorengine.tineye.com/docs/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multicolor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multicolor
+
+## Usage Examples
+
+### Instantiating a client
+
+```ruby
+client = Multicolor::REST::Client.new do |client|
+  client.config.company      = "<api-company>"
+  client.config.username     = "<api-username>"
+  client.config.password     = "<password>"
+end
+```
+
+### Adding or deleting items
+
+```ruby
+data = [
+  {
+    url: "http://url-to-image",
+    filepath: "/path/to/image",
+    metadata: {
+      ...
+    }
+  },
+  {
+    url: "http://url-to-other-image",
+    filepath: "/path/to/another/image",
+    metadata: {
+      ...
+    }
+  },
+]
+
+client.add(data) # add the image to the collection
+
+client.delete(["/path/to/image", another_"/path/to/image"] ) # delete images
+client.delete("/path/to/image") # pass a single filepath to delete a single image
+```
+
+### searching the index
+
+```ruby
+# searching for similar colors
+params = {
+  colors: [
+    {
+      color: #rgb or hex
+      width: 1-100
+    }...
+  ],
+  min_score: 0-11
+  offset: integer
+  ...
+}
+
+# Multicolor::REST::SearchBuilder is a convenience method
+# that formats params to format required by
+# the MulticolorEngine, eg: color[0], color[1]....
+search_options = Multicolor::REST::SearchBuilder.new(params).request
+
+response = client.color_search(search_options)
+response.body # returns API response
+```
+
+### Metadata
+
+```ruby
+
+# extract colors for n images identified by filepath
+options = {
+  filepaths: ["/path/to/image", "/path/to/another/image"]
+  limit: 20
+}
+client.extract_collection_colors(options)
+
+# extract metadata for n images
+client.get_metadata(filepaths: ["/path/to/image"])
+
+# count collection colors
+
+options = {
+  count_colors: ["233,233,233","23,33,91"]
+  filepaths: ["/path/to/image", "/path/to/other/image"]
+  ...
+}
+
+client.count_collection_colors(options)
+
+```
+
+### Info
+
+```ruby
+# counting items in the collection/index
+client.count
+
+# List the images present in your API.
+client.list
+
+# pinging the API to see if the Piximilar search server is running.
+client.ping
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/multicolor.rb

@@ -0,0 +1,19 @@
+require 'active_support/core_ext'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'multicolor/configuration'
+require 'multicolor/util'
+require 'multicolor/version'
+require 'multicolor/errors/bad_response'
+require 'multicolor/errors/company_not_set'
+require 'multicolor/rest'
+require 'multicolor/rest/client'
+require 'multicolor/rest/search_builder'
+require 'multicolor/rest/endpoints'
+require 'multicolor/rest/endpoints/filepath'
+require 'multicolor/rest/endpoints/indexing'
+require 'multicolor/rest/endpoints/metadata'
+
+module Multicolor
+end

data/lib/multicolor/configuration.rb

@@ -0,0 +1,22 @@
+module Multicolor
+  class Configuration
+    attr_accessor :timeout, :open_timeout, :username, :password, :company
+
+    def valid?
+      # TODO
+      # are username, company, password set?
+    end
+
+    def authenticate?
+      true
+    end
+
+    def timeout
+      @timeout || 40
+    end
+
+    def open_timeout
+      @open_timeout || 40
+    end
+  end
+end

data/lib/multicolor/errors/bad_response.rb

@@ -0,0 +1,5 @@
+module Multicolor
+  module Errors
+    class BadResponse < StandardError; end
+  end
+end

data/lib/multicolor/errors/company_not_set.rb

@@ -0,0 +1,5 @@
+module Multicolor
+  module Errors
+    class CompanyNotSet < StandardError; end
+  end
+end

data/lib/multicolor/rest.rb

@@ -0,0 +1,4 @@
+module Multicolor
+  module REST
+  end
+end

data/lib/multicolor/rest/client.rb

@@ -0,0 +1,26 @@
+require 'multicolor/rest/transport'
+
+module Multicolor
+  module REST
+    class Client
+      delegate :get_search_metadata, :get_return_metadata,
+        :count, :list, :ping, :add, :delete, :get_metadata,
+        :update_metadata, :color_search,
+        :extract_collection_colors, to: :transport
+
+      def initialize(options = {})
+        yield(self) if block_given?
+      end
+
+      def config
+        @configuration ||= Multicolor::Configuration.new
+      end
+
+      private
+
+      def transport
+        @transport ||= Multicolor::REST::Transport.new(config)
+      end
+    end
+  end
+end

data/lib/multicolor/rest/endpoints.rb

@@ -0,0 +1,6 @@
+module Multicolor
+  module REST
+    module Endpoints
+    end
+  end
+end

data/lib/multicolor/rest/endpoints/filepath.rb

@@ -0,0 +1,25 @@
+module Multicolor
+  module REST
+    module Endpoints
+      module Filepath
+        def color_search(options)
+          post(:color_search, options)
+        end
+
+        def extract_collection_colors(options)
+          filepaths = options.delete(:filepaths)
+          get(:extract_collection_colors, Multicolor::Util.filepaths(filepaths).merge(options))
+        end
+
+        def get_metadata(options)
+          filepaths = options.delete(:filepaths)
+          get(:get_metadata, Multicolor::Util.filepaths(filepaths).merge(options))
+        end
+
+        def update_metadata(payload)
+          post(:update_metadata, Multicolor::Util.payload_builder(payload))
+        end
+      end
+    end
+  end
+end

data/lib/multicolor/rest/endpoints/indexing.rb

@@ -0,0 +1,15 @@
+module Multicolor
+  module REST
+    module Endpoints
+      module Indexing
+        def add(payload)
+          post(:add, Multicolor::Util.payload_builder(payload))
+        end
+
+        def delete(filepaths)
+          post(:delete, Multicolor::Util.filepaths(filepaths))
+        end
+      end
+    end
+  end
+end

data/lib/multicolor/rest/endpoints/metadata.rb

@@ -0,0 +1,54 @@
+module Multicolor
+  module REST
+    module Endpoints
+      module Metadata
+        # {
+        #   count_colors: ["122,233,433", "343,433,333"]
+        #   filepaths: ["/one/image", "/another/image"]
+        #   metadata: {
+        #     ...
+        #   }
+        # }
+        def count_collection_colors(options)
+          keys = [:count_colors, :weights, :filepaths]
+          formatted_options = extract_and_format_options(options, keys)
+          get(:count_collection_colors, formatted_options)
+        end
+
+        def count_metadata(options)
+          keys = [:colors, :count_metadata, :weights, :filepaths]
+          formatted_options = extract_and_format_options(options, keys)
+          get(:count_metadata, formatted_options)
+        end
+
+        def get_search_metadata
+          get(:get_search_metadata)
+        end
+
+        def get_return_metadata
+          get(:get_return_metadata)
+        end
+
+        def count
+          get(:count)
+        end
+
+        def list(options = {})
+          get(:list, options)
+        end
+
+        def ping
+          get(:ping)
+        end
+
+        private
+
+        def extract_and_format_options(options, keys)
+          payload = Multicolor::Util.payload_builder(options.delete(:colors))
+          options = Multicolor::Util::modify_options_for_keys(options, keys)
+          options.merge(payload)
+        end
+      end
+    end
+  end
+end

data/lib/multicolor/rest/search_builder.rb

@@ -0,0 +1,40 @@
+module Multicolor
+  module REST
+    class SearchBuilder
+      attr_reader :keys, :params
+
+      def initialize(params, *keys)
+        @params = params
+        @keys = keys.any? ? allowed_params & keys : allowed_params
+      end
+
+      def request
+        built
+          .merge(Multicolor::Util.build_colors(built.delete(:colors)))
+          .merge(return_metadata: built.delete(:return_metadata).to_json) # son of a bitch
+          .delete_if{ |k,v| v.nil? }
+      end
+
+      private
+
+      def built
+        @built ||= params.slice(*keys)
+      end
+
+      def allowed_params
+        [
+         :filepath,
+         :colors,
+         :weights,
+         :ignore_background,
+         :ignore_interior_background,
+         :return_metadata,
+         :metadata,
+         :min_score,
+         :offset,
+         :limit
+        ]
+      end
+    end
+  end
+end

data/lib/multicolor/rest/transport.rb

@@ -0,0 +1,54 @@
+require 'multicolor/rest/endpoints/filepath'
+require 'multicolor/rest/endpoints/indexing'
+require 'multicolor/rest/endpoints/metadata'
+
+module Multicolor
+  module REST
+    class Transport
+      include Multicolor::REST::Endpoints::Filepath
+      include Multicolor::REST::Endpoints::Indexing
+      include Multicolor::REST::Endpoints::Metadata
+
+      attr_reader :client, :config
+
+      delegate :company, to: :config
+
+      def initialize(config)
+        @config = config
+
+        @client = Faraday.new(url: url) do |conn|
+          conn.request  :multipart
+          conn.request  :url_encoded
+          conn.response :json
+          conn.adapter  :net_http
+
+          conn.use Faraday::Response::RaiseError
+
+          conn.options[:timeout]      = config.timeout
+          conn.options[:open_timeout] = config.open_timeout
+
+          conn.basic_auth(config.username, config.password) if config.authenticate?
+        end
+      end
+
+      private
+
+      def get(endpoint, params = {}, &block)
+        client.get(api_path(endpoint), params, &block)
+      end
+
+      def post(endpoint, params = {}, &block)
+        client.post(api_path(endpoint), params, &block)
+      end
+
+      def url
+        "http://multicolorengine.tineye.com"
+      end
+
+      def api_path(endpoint)
+        raise Multicolor::Errors::CompanyNotSet if company.nil?
+        "#{company}/rest/#{endpoint}"
+      end
+    end
+  end
+end

data/lib/multicolor/util.rb

@@ -0,0 +1,54 @@
+module Multicolor
+  module Util
+    class << self
+      def param_builder(params)
+        new_params = {}
+        new_params.merge!(filepaths(params[:filepaths]))
+        new_params
+      end
+
+      def filepaths(filename)
+        Array.wrap(filename).inject({}) do |data, item|
+          data["filepaths[#{data.keys.count}]"] = item
+          data
+        end
+      end
+
+      def build_colors(params)
+        payload_builder(flatten_colors(params))
+      end
+
+      def flatten_colors(params)
+        params.is_a?(Hash) ? params.values : params
+      end
+
+      def payload_builder(payload)
+        processed = 0
+        data = {}
+        (payload || {}).each do |entry|
+          entry.keys.each do |key|
+            value = entry[key]
+            data["#{key.to_s.pluralize}[#{processed}]"] = value.is_a?(Hash) ? value.to_json : value
+          end
+          processed += 1
+        end
+        data
+      end
+
+      def modify_options_for_keys(options, keys)
+        options.symbolize_keys!
+        subset = options.slice(*keys)
+        subset.each do |key, value|
+          data = {}
+          Array.wrap(value).each do |val|
+            data["#{key.to_s.pluralize}[#{data.keys.length}]"] = val
+          end
+          options.merge!(data)
+        end
+
+        keys.each{ |key| options.delete(key) }
+        options
+      end
+    end
+  end
+end

data/lib/multicolor/version.rb

@@ -0,0 +1,3 @@
+module Multicolor
+  VERSION = "0.1.1"
+end

data/multicolor.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multicolor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multicolor"
+  spec.version       = Multicolor::VERSION
+  spec.authors       = ["ramin keene"]
+  spec.email         = ["raminkeene@gmail.com"]
+  spec.description   = %q{ ruby api client for TinEye Multicolor API}
+  spec.summary       = %q{ ruby api client for easy interaction with TinEye Multicolor API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "faraday", "~> 0.8.9"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "json", ">= 1.8.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/multicolor/configuration_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Multicolor::Configuration do
+  describe '#timeout' do
+    it 'defaults to 40' do
+      expect(subject.timeout).to eq(40)
+    end
+
+    it 'sets timeout' do
+      subject.timeout = 20
+      expect(subject.timeout).to eq(20)
+    end
+  end
+
+  describe '#authenticate?' do
+    it 'is true' do
+      expect(subject.authenticate?).to eq(true)
+    end
+  end
+
+  describe '#open_timeout' do
+    it 'defaults to 40' do
+      expect(subject.open_timeout).to eq(40)
+    end
+
+    it 'sets open_timeout' do
+      subject.open_timeout = 20
+      expect(subject.open_timeout).to eq(20)
+    end
+  end
+end

data/spec/multicolor/rest/client_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Multicolor::REST::Client do
+  context 'delegation to transport' do
+    describe '.delegate' do
+      let(:delegated) {
+        [:get_search_metadata, :get_return_metadata,
+         :count, :list, :ping, :add, :delete, :get_metadata,
+         :update_metadata, :color_search,
+         :extract_collection_colors
+        ]
+      }
+
+      let(:transport) { double('Transport') }
+
+      before do
+        allow(Multicolor::REST::Transport).to receive(:new).and_return(transport)
+      end
+
+      it 'delegates' do
+        delegated.each do |method|
+          expect(transport).to receive(method)
+          expect(subject.respond_to?(:method)).to eq(true)
+          subject.send(method)
+        end
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it 'yields self if block_given?' do
+      expect{ |block| Multicolor::REST::Client.new(&block) }.to yield_control
+    end
+  end
+
+  describe '#transport' do
+    it 'should initialize a transport object' do
+      expect(Multicolor::REST::Transport).to receive(:new)
+      subject.send(:transport)
+    end
+  end
+
+  describe '#config' do
+    it 'should initialize a configuration object' do
+      expect(Multicolor::Configuration).to receive(:new)
+      subject.config
+    end
+  end
+end

data/spec/multicolor/rest/endpoints/filepath_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Multicolor::REST::Endpoints::Filepath do
+  before do
+    class TransportClass
+      include Multicolor::REST::Endpoints::Filepath
+    end
+  end
+
+  subject{ TransportClass.new }
+
+  describe '#color_search' do
+    it 'makes a post request' do
+      expect(subject)
+        .to receive(:post)
+        .with(:color_search, {})
+      subject.send(:color_search, {})
+    end
+  end
+
+  describe '#extract_collection_colors' do
+    it 'makes a post request' do
+      expect(subject)
+        .to receive(:get)
+        .with(:extract_collection_colors, {})
+
+      subject.send(:extract_collection_colors, {})
+    end
+  end
+
+  describe '#get_metadata' do
+    it 'makes a get request' do
+      expect(subject)
+        .to receive(:get)
+       .with(:get_metadata, { "filepaths[0]" => "huh" })
+      subject.send(:get_metadata, { filepaths: ["huh"] })
+    end
+  end
+
+  describe '#update_metadata' do
+    it 'makes a post request' do
+      expect(subject)
+        .to receive(:post)
+        .with(:update_metadata, { })
+
+      subject.send(:update_metadata, [])
+    end
+  end
+end

data/spec/multicolor/rest/endpoints/indexing_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Multicolor::REST::Endpoints::Indexing do
+  before do
+    class IndexingTransportClass
+      include Multicolor::REST::Endpoints::Indexing
+    end
+  end
+
+  subject{ IndexingTransportClass.new }
+
+  describe '#color_search' do
+    it 'makes a post request' do
+      expect(subject)
+        .to receive(:post)
+        .with(:add, {})
+
+      expect(Multicolor::Util)
+        .to receive(:payload_builder)
+        .with({})
+        .and_return({})
+
+      subject.send(:add, {})
+    end
+  end
+
+  describe '#extract_collection_colors' do
+    it 'makes a post request' do
+      expect(subject)
+        .to receive(:post)
+        .with(:delete, {})
+
+      expect(Multicolor::Util)
+        .to receive(:filepaths)
+        .with({})
+        .and_return({})
+
+      subject.send(:delete, {})
+    end
+  end
+end

data/spec/multicolor/rest/endpoints/metadata_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe Multicolor::REST::Endpoints::Filepath do
+  before do
+    class TransportMetadataClass
+      include Multicolor::REST::Endpoints::Metadata
+    end
+  end
+
+  subject{ TransportMetadataClass.new }
+
+  describe '#count_collection_colors' do
+
+    let(:params) do
+      {
+        count_colors: [ "red", "green", "blue"],
+        colors: [
+          {
+            color: "huh",
+            weight: "20"
+          },
+          {
+            color: "nope",
+            weight: "30"
+          },
+        ]
+      }
+    end
+
+    it 'makes a get request' do
+      expect(subject)
+        .to receive(:get)
+        .with(:count_collection_colors, {})
+      subject.send(:count_collection_colors, {})
+    end
+  end
+
+  describe '#get_search_metadata' do
+    it 'makes a get request' do
+      expect(subject)
+        .to receive(:get)
+        .with(:get_search_metadata)
+      subject.send(:get_search_metadata)
+    end
+  end
+
+  describe '#get_return_metadata' do
+    it 'makes a get request' do
+      expect(subject)
+        .to receive(:get)
+        .with(:get_return_metadata)
+      subject.send(:get_return_metadata)
+    end
+  end
+
+  describe '#count' do
+    it 'makes a get request' do
+      expect(subject)
+        .to receive(:get)
+        .with(:count)
+      subject.send(:count)
+    end
+  end
+
+  describe '#list' do
+    it 'makes a get request' do
+      expect(subject)
+        .to receive(:get)
+        .with(:list, {})
+      subject.send(:list)
+    end
+  end
+
+  describe '#ping' do
+    it 'makes a get request' do
+      expect(subject)
+        .to receive(:get)
+        .with(:ping)
+      subject.send(:ping)
+    end
+  end
+end

data/spec/multicolor/rest/search_builder_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Multicolor::REST::SearchBuilder do
+  let(:keys)   {  []  }
+  let(:params) {  {}  }
+
+  let(:colors) {
+    [
+     {
+       color: "red",
+       weight: 50,
+     },
+     {
+       color: "blue",
+     },
+     {
+       color: "green",
+       weight: 70,
+     }
+    ]
+  }
+
+  subject { Multicolor::REST::SearchBuilder.new(params.with_indifferent_access, *keys) }
+  let(:request) { subject.request }
+
+  context 'filepath' do
+    let(:params) {
+      { filepath: "poop" }
+    }
+
+    it 'keeps filepath intact' do
+      expect(request["filepath"]).to eq("poop")
+    end
+  end
+
+  context 'param whitelist' do
+    let(:params) {
+      {
+        limit: 10,
+        offset: 20,
+        min_score: 100,
+        wu_tang: :killah_bees
+      }
+    }
+
+    it 'keeps whitelisted params and strips rest' do
+      expect(request.keys.count).to eq(4)
+      expect(request["wu_tang"]).to eq(nil)
+    end
+  end
+
+  context 'colors' do
+    let(:params) {
+      { colors: colors }.stringify_keys
+    }
+
+    it 'formats colors into array indexes colors and weight' do
+      expect(request["colors[0]"]).to eq("red")
+      expect(request["colors[1]"]).to eq("blue")
+      expect(request["colors[2]"]).to eq("green")
+    end
+
+    it 'formats colors into array indexes colors and weight' do
+      expect(request["weights[0]"]).to eq(50)
+      expect(request["weights[1]"]).to eq(nil)
+      expect(request["weights[2]"]).to eq(70)
+    end
+
+    it 'skips adding a weight for the second color' do
+      expect(request.keys.count).to eq(6)
+      expect(request["weights[1]"]).to eq(nil)
+    end
+  end
+end

data/spec/multicolor/rest/transport_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Multicolor::REST::Transport do
+  let(:config) { Multicolor::Configuration.new }
+  subject      { Multicolor::REST::Transport.new(config) }
+
+  context 'request helpers' do
+    let(:client) { double("Client") }
+
+    before do
+      allow(Faraday).to receive(:new).and_return(client)
+      expect(subject).to receive(:api_path).and_return("/something")
+    end
+
+    describe '#get' do
+      it 'should proxy get to the initialized Faraday client' do
+        expect(client).to receive(:get).with("/something", {})
+        subject.send(:get, "/something", {})
+      end
+    end
+
+    describe '#post' do
+      it 'should proxy get to the initialized Faraday client' do
+        expect(client).to receive(:post).with("/something", {})
+        subject.send(:post, "/something", {})
+      end
+    end
+  end
+
+  describe '#api_path' do
+    context 'when no company has been configured' do
+      it 'should raise an error' do
+        expect{ subject.send(:api_path, "poop") }
+          .to raise_error(Multicolor::Errors::CompanyNotSet)
+      end
+    end
+  end
+
+  it 'sets the url to point at tineye multicolor' do
+    expect(subject.send(:url)).to eq("http://multicolorengine.tineye.com")
+  end
+end

data/spec/multicolor/util_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+describe Multicolor::Util do
+  subject { Multicolor::Util }
+
+  let(:params) do
+    { poop: "haha", filepaths: [:first, :second, :third] }
+  end
+
+  let(:output) {
+    {
+      "filepaths[0]" => :first,
+      "filepaths[1]" => :second,
+      "filepaths[2]" => :third
+    }
+  }
+
+  describe '.param_builder' do
+    it 'builds filepath params' do
+      expect(subject.param_builder(params)).to eq(output)
+    end
+  end
+
+  describe '.filepaths' do
+    it 'formats a single filepath' do
+      expect(subject.filepaths("whatever")).to eq({ "filepaths[0]" => "whatever" })
+    end
+
+    it 'formats an list (array) of filepaths' do
+      expect(subject.filepaths(params[:filepaths])).to eq(output)
+    end
+  end
+
+  context 'colors via ajax' do
+    let(:data) {
+      {
+        "0" => {
+          "color" => "red",
+          "weight" => "23"
+        }
+      }
+    }
+
+    describe '.flatten_colors' do
+      it 'should turn a ajax encoded colors hash back to an array' do
+        expect(subject.flatten_colors(data)).to eq([ { "color" => "red", "weight" => "23" } ])
+      end
+
+      it 'leaves properly formatted data alone' do
+        safe_data = [{ "color" => "red" }]
+        expect(subject.flatten_colors(safe_data)).to eq(safe_data)
+      end
+    end
+
+    describe '.build_colors' do
+      let(:output) { { "colors[0]" => "red", "weights[0]" => "23" } }
+
+      it 'flattens the processed hash and encodes as API params' do
+        expect(subject.build_colors(data)).to eq(output)
+      end
+    end
+  end
+
+  context 'payload builder' do
+    let(:entry) {
+      {
+        "filepath" => "poop",
+        "url" => "http://url.com",
+        "metadata" => {
+          "keywords" => [:huh, :hee],
+          "post_id"   => { "action" => "return", "type"   => "uint",   "" => rand(0..45) }
+        }
+      }
+    }
+
+    let(:payload) { [entry, entry, entry]  }
+
+    describe '.payload_builder' do
+      it 'transforms an array of hashes into array indexed param parts' do
+        output = subject.payload_builder(payload)
+
+        expect(output.keys.count).to eq(9)
+
+        expect(output["filepaths[0]"]).to_not eq(nil)
+        expect(output["filepaths[1]"]).to_not eq(nil)
+        expect(output["filepaths[2]"]).to_not eq(nil)
+
+        expect(output["urls[0]"]).to_not eq(nil)
+        expect(output["urls[1]"]).to_not eq(nil)
+        expect(output["urls[2]"]).to_not eq(nil)
+
+        expect(output["metadata[0]"]).to_not eq(nil)
+        expect(output["metadata[1]"]).to_not eq(nil)
+        expect(output["metadata[2]"]).to_not eq(nil)
+      end
+    end
+
+    describe '.modify_options_for_keys' do
+      let(:data) do
+        {
+          other: [1, 4],
+          things: [1, 2],
+          cant_touch: :this,
+          please_hammer: :dont_hurt_em,
+          colors: [
+            {
+              color: "huh",
+              weight: "20"
+            },
+            {
+              color: "nope",
+              weight: "30"
+            },
+          ]
+        }
+      end
+
+      let(:modifiable_keys) { [:other, :things, :colors] }
+
+      it 'transforms a hash of arrays into array indexed param parts for specified keys' do
+        transformed = subject.modify_options_for_keys(data, modifiable_keys)
+        expect((transformed.keys & modifiable_keys).count).to eq(0)
+        expect((transformed.keys & ["things[0]", "things[1]"]).count).to eq(2)
+        expect((transformed.keys & ["others[0]", "others[1]"]).count).to eq(2)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'active_support'
+require 'multicolor'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.color = true
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: multicolor
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ramin keene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  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: activesupport
+  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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " ruby api client for TinEye Multicolor API"
+email:
+- raminkeene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multicolor.rb
+- lib/multicolor/configuration.rb
+- lib/multicolor/errors/bad_response.rb
+- lib/multicolor/errors/company_not_set.rb
+- lib/multicolor/rest.rb
+- lib/multicolor/rest/client.rb
+- lib/multicolor/rest/endpoints.rb
+- lib/multicolor/rest/endpoints/filepath.rb
+- lib/multicolor/rest/endpoints/indexing.rb
+- lib/multicolor/rest/endpoints/metadata.rb
+- lib/multicolor/rest/search_builder.rb
+- lib/multicolor/rest/transport.rb
+- lib/multicolor/util.rb
+- lib/multicolor/version.rb
+- multicolor.gemspec
+- spec/multicolor/configuration_spec.rb
+- spec/multicolor/errors_spec.rb
+- spec/multicolor/rest/client_spec.rb
+- spec/multicolor/rest/endpoints/filepath_spec.rb
+- spec/multicolor/rest/endpoints/indexing_spec.rb
+- spec/multicolor/rest/endpoints/metadata_spec.rb
+- spec/multicolor/rest/search_builder_spec.rb
+- spec/multicolor/rest/transport_spec.rb
+- spec/multicolor/util_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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 api client for easy interaction with TinEye Multicolor API
+test_files:
+- spec/multicolor/configuration_spec.rb
+- spec/multicolor/errors_spec.rb
+- spec/multicolor/rest/client_spec.rb
+- spec/multicolor/rest/endpoints/filepath_spec.rb
+- spec/multicolor/rest/endpoints/indexing_spec.rb
+- spec/multicolor/rest/endpoints/metadata_spec.rb
+- spec/multicolor/rest/search_builder_spec.rb
+- spec/multicolor/rest/transport_spec.rb
+- spec/multicolor/util_spec.rb
+- spec/spec_helper.rb