lateral_recommender 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7a0f681409eec2cab830696e733f170b58185f4
-  data.tar.gz: 03d84fcb2afb9ce72ec31015d1b9af359d3b2d68
+  metadata.gz: b8491268138fe3245bfd4bf5d540c20a2f565ba7
+  data.tar.gz: 12982074d5851afb30352de54f0b1aecdb9d8f2c
 SHA512:
-  metadata.gz: 89d11aa40b298880259f0f570d0b3545e229ca080152a01759814cefd7fbf7d12665a37870cafdb1d869f9650215cb21b1ae9029ce9df67b4e0f07cad87665c6
-  data.tar.gz: 0bf3617cc412fb6637a9b4fd10ae136f7d3603c27a8723bf98c0912b4209697499ac7c4ef72bd4354d14595257b4ed8b6ff25d9abb5b8114b8e620f5c7b7ab73
+  metadata.gz: aa59ad025aeed4b98fe543ac9773d83cbaf9ecd26f3fbabcfebfc15aa946b6f11c42bdf136ecd2b0d18d3aa2a964cc823890caa008ab3ffde8e218a2a1f18983
+  data.tar.gz: 6bd9cdaab70c16e491c615c05ef830ebbe8a1ef3991535439847c61b9cdad95ed497a220678335cfd378e4047207ee855e989995b068dd39b0ef50ae910a6bc4

data/README.md

@@ -64,7 +64,7 @@ If you don't want to insert your own documents to the API, you can query one of
 
 * **[arXiv](https://lateral.io/docs/text-matching/pre-populated-recommenders#arxiv)** - 1M+ academic papers in Physics, Mathematics and Computer Science (updated daily)
 * **[News](https://lateral.io/docs/text-matching/pre-populated-recommenders#news)** - 250,000+ curated news articles (updated every 15mins)
-* **[PubMed](https://lateral.io/docs/text-matching/pre-populated-recommenders#pubmed)** - 20M+ medical journals (from June 2014)
+* **[PubMed](https://lateral.io/docs/text-matching/pre-populated-recommenders#pubmed)** - 6M+ medical journals (from before July 2014)
 * **[SEC Data](https://lateral.io/docs/text-matching/pre-populated-recommenders#sec-data)** - 6,000+ yearly financial reports / 10-K filings (from 2014)
 * **[Wikipedia](https://lateral.io/docs/text-matching/pre-populated-recommenders#wikipedia)** - 463,000 Wikipedia pages (which had 20+ page views in 2013)
 

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lateral_recommender.gemspec

@@ -16,12 +16,10 @@ Gem::Specification.new do |spec|
   spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'awesome_print', '~> 1.6', '>= 1.6.1'
-  spec.add_development_dependency 'rake', '~> 10.4', '>= 10.4.2'
-  spec.add_development_dependency 'rspec', '~> 3.2', '>= 3.2.0'
-  spec.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
-  spec.add_development_dependency 'webmock', '~> 1.21', '>= 1.21.0'
-  spec.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.6'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
 
   spec.add_runtime_dependency 'httparty'
   spec.add_runtime_dependency 'json'

data/lib/lateral_recommender.rb

@@ -5,15 +5,15 @@ require 'json'
 
 module LateralRecommender
   class API
-    EXTERNAL_CORPORA = %w(arxiv news pubmed sec wikipedia)
+    JSON_HEADERS = { 'Content-Type' => 'application/json' }
+    EXTERNAL_CORPORA = %w(arxiv news pubmed sec wikipedia bloomberg-public)
 
     # @param [String] key The Lateral API key
-    # @param [String] corpus The corpora to recommend from e.g. arxiv, sec, pubmed, wikipedia, news
+    # @param [String] corpus The corpora to recommend from e.g. arxiv, sec, pubmed, wikipedia, news, bloomberg-public
     def initialize(key, corpus = 'recommender')
-      corpus = EXTERNAL_CORPORA.include?(corpus) ? corpus : 'recommender'
-      @endpoint = "https://#{corpus}-api.lateral.io/"
+      @corpus = EXTERNAL_CORPORA.include?(corpus) ? corpus : 'recommender'
+      @endpoint = "https://#{@corpus}-api.lateral.io/"
       @key = key
-      # @client = HTTPClient.new
     end
 
     # Add a document to the recommender
@@ -65,7 +65,7 @@ module LateralRecommender
 
     private
 
-    def req(request)
+    def parse_request(request)
       return { error: error(request) } if request.code != 200 && request.code != 201
       JSON.parse(request.body)
     end
@@ -81,11 +81,21 @@ module LateralRecommender
     end
 
     def post(path, params)
-      req HTTParty.post url(path), body: params
+      return parse_request request 'post', path, params if @corpus == 'recommender'
+      parse_request request_json 'post', path, params.merge(collection: [@corpus])
     end
 
     def get(path, params)
-      req HTTParty.get url(path), body: params
+      return parse_request request 'get', path, params if @corpus == 'recommender'
+      parse_request request_json 'get', path, params.merge(collection: [@corpus])
+    end
+
+    def request(method, path, params)
+      HTTParty.send method, url(path), body: params
+    end
+
+    def request_json(method, path, params)
+      HTTParty.send method, url(path), body: params.to_json, headers: JSON_HEADERS
     end
   end
 end

data/lib/lateral_recommender/version.rb

@@ -1,3 +1,3 @@
 module LateralRecommender
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/lateral_recommender_spec.rb

@@ -1,132 +1,108 @@
 require 'spec_helper'
 
 describe LateralRecommender do
+
+  # Clear the test key first
+  HTTParty.post "https://recommender-api.lateral.io/delete-all/?subscription-key=#{ENV['API_KEY']}"
+
   describe 'API' do
     let(:api) { LateralRecommender::API.new ENV['API_KEY'] }
     let(:body) { File.read('spec/fixtures/article-body.txt') }
 
     it 'errors with invalid API key' do
       api = LateralRecommender::API.new 'no'
-      VCR.use_cassette('invalid_key') do
-        response = api.recommend_by_text 'test'
-        expect(response[:error][:status_code]).to eq(403)
-        expect(response[:error][:message]).to include('credentials are invalid')
-      end
+      response = api.recommend_by_text 'test'
+      expect(response[:error][:status_code]).to eq(403)
+      expect(response[:error][:message]).to include('Invalid authentication credentials')
     end
 
     it 'adds a document' do
-      VCR.use_cassette('add') do
-        response = api.add document_id: 'doc_id', text: body
-        expect(response['document_id']).to eq('doc_id')
-        expect(response['text']).to include('Space exploration')
-      end
+      response = api.add document_id: 'doc_id', text: body
+      expect(response['document_id']).to eq('doc_id')
+      expect(response['text']).to include('Space exploration')
     end
 
     it 'gets recommendations from text' do
-      VCR.use_cassette('recommend_by_text') do
-        response = api.recommend_by_text body
-        expect(response.length).to eq(1)
-        expect(response.first['document_id']).to eq('doc_id')
-      end
+      response = api.recommend_by_text body
+      expect(response.length).to eq(1)
+      expect(response.first['document_id']).to eq('doc_id')
     end
 
     it 'gets recommendations by ID' do
-      VCR.use_cassette('recommend_by_id') do
-        response = api.recommend_by_id 'doc_id'
-        expect(response.length).to eq(1)
-        expect(response.first['document_id']).to eq('doc_id')
-      end
+      response = api.recommend_by_id 'doc_id'
+      expect(response.length).to eq(1)
+      expect(response.first['document_id']).to eq('doc_id')
     end
 
     it 'gets recommendations by text in SEC' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'sec'
-      VCR.use_cassette('recommend_by_text_sec') do
-        response = api.recommend_by_text body, collections: '["item1a"]'
-        expect(response.length).to eq(10)
-        expect(response.first['title']).to include('DIGITALGLOBE, INC._2014_10')
-      end
+      response = api.recommend_by_text body, collections: %w(item1a)
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to include('DIGITALGLOBE, INC._2014_10')
     end
 
     it 'gets recommendations by ID in SEC' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'sec'
-      VCR.use_cassette('recommend_by_id_sec') do
-        id = 'SEC_item_1A-http://www.sec.gov/Archives/edgar/data/1099369/0001062993-14-006877.txt_item_1A'
-        response = api.recommend_by_id id, collections: '["item1a"]'
-        expect(response.length).to eq(10)
-        expect(response.first['title']).to include('DESTINY MEDIA TECHNOLOGIES')
-      end
+      id = 'SEC_item_1A-http://www.sec.gov/Archives/edgar/data/1099369/0001062993-14-006877.txt_item_1A'
+      response = api.recommend_by_id id, collections: %w(item1a)
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to include('DESTINY MEDIA TECHNOLOGIES')
     end
 
     it 'gets recommendations by text in news' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'news'
-      VCR.use_cassette('recommend_by_text_news') do
-        response = api.recommend_by_text body
-        expect(response.length).to be > 10 # This should be done better
-        expect(response.first['title']).to include('NASA announces details of ')
-      end
+      response = api.recommend_by_text body
+      expect(response.length).to be > 10 # This should be done better
+      expect(response.first['title']).to include('NASA Announces Next Steps ')
     end
 
     it 'gets recommendations from ID in news' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'news'
-      VCR.use_cassette('recommend_by_id_news') do
-        response = api.recommend_by_id '3076491'
-        expect(response.length).to be > 10 # This should be done better
-        expect(response.first['title']).to include('Goodbye MongoDB, Hello Pos')
-      end
+      response = api.recommend_by_id '3076491'
+      expect(response.length).to be > 10 # This should be done better
+      expect(response.first['title']).to include('Tree structure query with ')
     end
 
     it 'gets recommendations by text in wikipedia' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'wikipedia'
-      VCR.use_cassette('recommend_by_text_wikipedia') do
-        response = api.recommend_by_text body
-        expect(response.length).to eq(10)
-        expect(response.first['title']).to eq('Space exploration')
-      end
+      response = api.recommend_by_text body
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to eq('Space exploration')
     end
 
     it 'gets recommendations by ID in wikipedia' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'wikipedia'
-      VCR.use_cassette('recommend_by_id_wikipedia') do
-        response = api.recommend_by_id 'wikipedia-11589297'
-        expect(response.length).to eq(10)
-        expect(response.first['title']).to eq('Manned mission to Mars')
-      end
+      response = api.recommend_by_id 'wikipedia-11589297'
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to eq('Manned mission to Mars')
     end
 
     it 'gets recommendations by text in pubmed' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'pubmed'
-      VCR.use_cassette('recommend_by_text_pubmed') do
-        response = api.recommend_by_text body
-        expect(response.length).to eq(10)
-        expect(response.first['title']).to include('NASA and the search')
-      end
+      response = api.recommend_by_text body
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to include('NASA and the search')
     end
 
-    # it 'gets recommendations by ID in pubmed' do
-    #   api = LateralRecommender::API.new ENV['API_KEY'], 'pubmed'
-    #   VCR.use_cassette('recommend_by_id_pubmed') do
-    #     response = api.recommend_by_id 'pubmed-15881781-1'
-    #     expect(response.length).to eq(10)
-    #     expect(response.first['title']).to include('NASA and the search')
-    #   end
-    # end
+    it 'gets recommendations by ID in pubmed' do
+      api = LateralRecommender::API.new ENV['API_KEY'], 'pubmed'
+      response = api.recommend_by_id 'pubmed-15881781-1'
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to include('Radiation analysis ')
+    end
 
     it 'gets recommendations by text in arxiv' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'arxiv'
-      VCR.use_cassette('recommend_by_text_arxiv') do
-        response = api.recommend_by_text body
-        expect(response.length).to eq(10)
-        expect(response.first['title']).to include('A Lunar L2-Farside')
-      end
+      response = api.recommend_by_text body
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to include('A Lunar L2-Farside')
     end
 
     it 'gets recommendations by ID in arxiv' do
       api = LateralRecommender::API.new ENV['API_KEY'], 'arxiv'
-      VCR.use_cassette('recommend_by_id_arxiv') do
-        response = api.recommend_by_id 'arxiv-http://arxiv.org/abs/1403.2165'
-        expect(response.length).to eq(10)
-        expect(response.first['title']).to include('Set-valued sorting index')
-      end
+      response = api.recommend_by_id 'arxiv-http://arxiv.org/abs/1403.2165'
+      expect(response.length).to eq(10)
+      expect(response.first['title']).to include('Set-valued sorting index')
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,11 @@
 require 'env_vars' unless ENV.include? 'TRAVIS_BUILD_ID'
-require 'vcr'
+# require 'vcr'
 require 'ap'
 require 'lateral_recommender'
-require 'webmock/rspec'
+# require 'webmock/rspec'
 
-VCR.configure do |c|
-  c.cassette_library_dir = 'spec/fixtures/tapes'
-  c.hook_into :webmock
-  c.filter_sensitive_data('<API_KEY>') { ENV['API_KEY'] }
-end
+# VCR.configure do |c|
+#   c.cassette_library_dir = 'spec/fixtures/tapes'
+#   c.hook_into :webmock
+#   c.filter_sensitive_data('<API_KEY>') { ENV['API_KEY'] }
+# end

metadata

@@ -1,161 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: lateral_recommender
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Max Novakovic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-15 00:00:00.000000000 Z
+date: 2015-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.4'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '10.4'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.2'
-    - - '>='
-      - !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'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.2.0
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.9.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.9'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 2.9.3
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.21'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.21'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: httparty
   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: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -165,32 +101,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .editorconfig
-- .gitignore
-- .rspec
-- .rubocop.yml
-- .travis.yml
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rspec
 - lateral_recommender.gemspec
 - lib/lateral_recommender.rb
 - lib/lateral_recommender/version.rb
 - spec/fixtures/article-body.txt
-- spec/fixtures/tapes/add.yml
-- spec/fixtures/tapes/invalid_key.yml
-- spec/fixtures/tapes/recommend_by_id.yml
-- spec/fixtures/tapes/recommend_by_id_arxiv.yml
-- spec/fixtures/tapes/recommend_by_id_news.yml
-- spec/fixtures/tapes/recommend_by_id_sec.yml
-- spec/fixtures/tapes/recommend_by_id_wikipedia.yml
-- spec/fixtures/tapes/recommend_by_text.yml
-- spec/fixtures/tapes/recommend_by_text_arxiv.yml
-- spec/fixtures/tapes/recommend_by_text_news.yml
-- spec/fixtures/tapes/recommend_by_text_pubmed.yml
-- spec/fixtures/tapes/recommend_by_text_sec.yml
-- spec/fixtures/tapes/recommend_by_text_wikipedia.yml
 - spec/lateral_recommender_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/lateral/recommender-gem
@@ -203,34 +127,21 @@ 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.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Wrapper around the Lateral API.
 test_files:
 - spec/fixtures/article-body.txt
-- spec/fixtures/tapes/add.yml
-- spec/fixtures/tapes/invalid_key.yml
-- spec/fixtures/tapes/recommend_by_id.yml
-- spec/fixtures/tapes/recommend_by_id_arxiv.yml
-- spec/fixtures/tapes/recommend_by_id_news.yml
-- spec/fixtures/tapes/recommend_by_id_sec.yml
-- spec/fixtures/tapes/recommend_by_id_wikipedia.yml
-- spec/fixtures/tapes/recommend_by_text.yml
-- spec/fixtures/tapes/recommend_by_text_arxiv.yml
-- spec/fixtures/tapes/recommend_by_text_news.yml
-- spec/fixtures/tapes/recommend_by_text_pubmed.yml
-- spec/fixtures/tapes/recommend_by_text_sec.yml
-- spec/fixtures/tapes/recommend_by_text_wikipedia.yml
 - spec/lateral_recommender_spec.rb
 - spec/spec_helper.rb