lateral 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c95672546d13d4474ec180392a6cf4f9c80b4baa
+  data.tar.gz: 18500d29ab160ea8d757989f0b8d99329a4c3029
+SHA512:
+  metadata.gz: d2cb643b2e87c97b248d928c1bf584aff8a1862add82326a703d41f6e19dc3bb06259869ef0427296b295b7e0bd1643be11f9883017d698d9918f652b1f552bf
+  data.tar.gz: a51d67380d5fffeb99180dd6eed80b513c93edd64378a50f5dfe9e8199a854dd78ac2f686596cdaaed1bdf51ec3f63f2fa5a2d4dcc12be63718ac4add066bccb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+  Exclude:
+   - 'bin/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ModuleLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,22 @@
+guard :bundler do
+  watch('Gemfile')
+end
+
+# This group allows to skip running the rest when RSpec fails
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec,
+        cmd:            'COVERAGE=false rspec --no-profile',
+        failed_mode:    :none,
+        all_after_pass: true,
+        all_on_start:   true do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
+
+  guard :rubocop, cli: '-D' do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Navin Peiris
+
+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,88 @@
+# Lateral
+
+Ruby wrapper for [lateral.io](https://lateral.io) content recommendation service. For more information on
+methods allowed, returned codes etc, see the [api docs](https://lateral.io/docs).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lateral'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lateral
+
+## Usage
+
+### Get an API Key
+
+You can get an API key from [https://lateral.io/](https://lateral.io/).
+
+### Use the service
+
+```ruby
+text_matcher = Lateral::TextMatcher.new API_KEY
+```
+
+#### Available methods
+
+NOTE: The hash-bang methods throws an error if the request failed while the non hash-bang methods return null
+
+```ruby
+# Adding documents
+text_matcher.add  document_id: 'document-id', text: 'document text'
+text_matcher.add! document_id: 'document-id', text: 'document text'
+
+# Deleting a document
+text_matcher.delete  document_id: 'document-id'
+text_matcher.delete! document_id: 'document-id'
+
+# Delete all documents
+text_matcher.delete_all
+text_matcher.delete_all!
+
+# Fetch a document
+text_matcher.fetch  document_id: 'document-id'
+text_matcher.fetch! document_id: 'document-id'
+
+# List document ids
+text_matcher.list
+text_matcher.list!
+
+# Recommend by id
+text_matcher.recommend_by_id  document_id: 'document-id', records: 20
+text_matcher.recommend_by_id! document_id: 'document-id', records: 20
+
+# Recommend by text
+text_matcher.recommend_by_text  text: 'some text', records: 20
+text_matcher.recommend_by_text! text: 'some text', records: 20
+
+# Update meta tags
+text_matcher.update_meta  document_id: 'document-id', meta: 'meta-tags'
+text_matcher.update_meta! document_id: 'document-id', meta: 'meta-tags'
+
+# Update text
+text_matcher.update_text  document_id: 'document-id', text: 'new document text'
+text_matcher.update_text! document_id: 'document-id', text: 'new document text'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/navinpeiris/lateral/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options << '--display-cop-names'
+end
+
+task default: %w(spec rubocop)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lateral"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lateral.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lateral/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'lateral'
+  spec.version = Lateral::VERSION
+  spec.authors = ['Navin Peiris']
+  spec.email   = ['navin.peiris@gmail.com']
+
+  spec.summary     = %q{Ruby wrapper for lateral.io content recommendation API}
+  spec.description = %q{Ruby wrapper for lateral.io content recommendation API}
+  spec.homepage    = 'https://github.com/navinpeiris/lateral'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.13.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.2.0'
+  spec.add_development_dependency 'rubocop', '~> 0.31.0'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+  spec.add_development_dependency 'simplecov', '~> 0.10.0'
+  spec.add_development_dependency 'guard-bundler', '~> 2.1.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5.0'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2.0'
+  spec.add_development_dependency 'terminal-notifier-guard', '~> 1.6.4'
+  spec.add_development_dependency 'terminal-notifier', '~> 1.6.2'
+end

data/lib/lateral.rb

@@ -0,0 +1,5 @@
+require 'lateral/version'
+require 'lateral/text_matcher'
+
+module Lateral
+end

data/lib/lateral/document.rb

@@ -0,0 +1,12 @@
+module Lateral
+  class Document
+    attr_reader :id, :created_at, :text, :meta
+
+    def initialize(args)
+      @id         = args.fetch 'document_id'
+      @created_at = args.fetch 'created_at'
+      @text       = args.fetch 'text'
+      @meta       = args.fetch 'meta', {}
+    end
+  end
+end

data/lib/lateral/error.rb

@@ -0,0 +1,20 @@
+module Lateral
+  class LateralError < StandardError
+    attr_reader :code
+
+    def initialize(code, message)
+      super message
+      @code = code
+    end
+
+    def self.from_response(response)
+      message = begin
+        JSON.parse(response.body)['message']
+      rescue JSON::ParserError
+        response.body
+      end
+
+      new(response.code, message)
+    end
+  end
+end

data/lib/lateral/recommendation.rb

@@ -0,0 +1,10 @@
+module Lateral
+  class Recommendation
+    attr_reader :document_id, :distance
+
+    def initialize(args)
+      @document_id = args.fetch 'document_id'
+      @distance    = args.fetch 'distance'
+    end
+  end
+end

data/lib/lateral/text_matcher.rb

@@ -0,0 +1,61 @@
+require 'httparty'
+
+require_relative 'document'
+require_relative 'recommendation'
+require_relative 'error'
+
+module Lateral
+  class TextMatcher
+    include HTTParty
+
+    base_uri 'https://recommender-api.lateral.io'
+    format :json
+    # debug_output $stdout
+
+    def initialize(api_key)
+      TextMatcher.default_params 'subscription-key' => api_key
+    end
+
+    API_METHODS = {
+      add:               { method: :post, endpoint: '/add/', result_class: Document },
+      delete:            { method: :post, endpoint: '/delete/', result_class: Document },
+      delete_all:        { method: :post, endpoint: '/delete-all/' },
+      fetch:             { method: :get, endpoint: '/fetch/', result_class: Document },
+      list:              { method: :get, endpoint: '/list/' },
+      recommend_by_id:   { method: :post, endpoint: '/recommend-by-id/', result_class: Recommendation },
+      recommend_by_text: { method: :post, endpoint: '/recommend-by-text/', result_class: Recommendation },
+      update_meta:       { method: :post, endpoint: '/update-meta/', result_class: Document },
+      update_text:       { method: :post, endpoint: '/update-text/', result_class: Document }
+    }
+
+    API_METHODS.each do |method, options|
+      define_method(method) do |args = nil|
+        call_api(args, options, raise_error_on_failure: false)
+      end
+
+      define_method("#{method}!") do |args = nil|
+        call_api(args, options, raise_error_on_failure: true)
+      end
+    end
+
+    private
+
+    def call_api(args, options, raise_error_on_failure: false)
+      response = self.class.send(options[:method], options[:endpoint], body: args)
+
+      if response.success?
+        return nil if response.body.nil? || response.body.empty?
+
+        result = JSON.parse(response.body)
+
+        if (result_class = options[:result_class])
+          result = result.is_a?(Array) ? (result.map { |r| result_class.new(r) }) : result_class.new(result)
+        end
+
+        result
+      else
+        fail LateralError.from_response(response) if raise_error_on_failure
+      end
+    end
+  end
+end

data/lib/lateral/version.rb

@@ -0,0 +1,3 @@
+module Lateral
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: lateral
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Navin Peiris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.31.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: guard-bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.2
+description: Ruby wrapper for lateral.io content recommendation API
+email:
+- navin.peiris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lateral.gemspec
+- lib/lateral.rb
+- lib/lateral/document.rb
+- lib/lateral/error.rb
+- lib/lateral/recommendation.rb
+- lib/lateral/text_matcher.rb
+- lib/lateral/version.rb
+homepage: https://github.com/navinpeiris/lateral
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for lateral.io content recommendation API
+test_files: []