europeana-api 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d80e47704d3b09489e1edbaed39ae4066fbb150
-  data.tar.gz: 9b7d7798b9bb9531e8456e14428d688add2f3b45
+  metadata.gz: 5e60507c8e8dc5319c78e0a3ac52e8607d5f1612
+  data.tar.gz: 4ed8fd8a37de256d4bea39fbdd1a681177225858
 SHA512:
-  metadata.gz: 0a1de32f7dd7001eaff9f0388e0d1cbe25751ea17e1b1138d4eddc58a395c669d976a7a20b39cbb6968b512705809c24ad9550d803a42188452152d8c999dd76
-  data.tar.gz: 1503c8b82c8e175031f87dc17b6edbe5bd8832502017ecb4a1e77ce0b9d9cdcab1c891117df18b91c73cb9b7a8db8b540ac587736da34aeef2d81d3ba118bb58
+  metadata.gz: 722db92332c4af3cef65a4521defd06e3b9bc405115b11e8ac0c505c3889fe3088c86ede80bdae523ac10a659daefcdc8e6cdbb172dc5d4e31da5c4d8f925698
+  data.tar.gz: 5b67320510f741164e972918fd2a102e0cc57b30233a7f432961b837ee3a0821277846023f771d1c3bb758d95b35437242c9cd1b899ce79270fcfd0c72e21802

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in europeana.gemspec
 gemspec
+
+group :test do
+  gem 'coveralls'
+end
+
+group :test, :develop do
+  gem 'rubocop'
+end

data/README.md

@@ -1,5 +1,7 @@
 # Europeana
 
+[![Build Status](https://travis-ci.org/rwd/europeana-api-client-ruby.svg?branch=master)](https://travis-ci.org/rwd/europeana-api-client-ruby) [![Coverage Status](https://coveralls.io/repos/rwd/europeana-api-client-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/rwd/europeana-api-client-ruby?branch=master) [![security](https://hakiri.io/github/rwd/europeana-api-client-ruby/master.svg)](https://hakiri.io/github/rwd/europeana-api-client-ruby/master)
+
 Ruby client library for the search and retrieval of records from the [Europeana
 REST API](http://labs.europeana.eu/api/introduction/).
 

data/lib/europeana/api/search.rb

@@ -10,6 +10,20 @@ module Europeana
       # Query params
       attr_accessor :params
 
+      class << self
+        ##
+        # Escapes Lucene syntax special characters for use in query parameters
+        #
+        # @param [String] text Text to escape
+        # @return [String] Escaped text
+        def escape(text)
+          specials = %w<\\ + - & | ! ( ) { } [ ] ^ " ~ * ? : / >
+          specials.each_with_object(text.dup) do |char, unescaped|
+            unescaped.gsub!(char, '\\\\' + char) # prepends *one* backslash
+          end
+        end
+      end
+
       ##
       # @param [Hash] params Europeana API request parameters for Search query
       def initialize(params = {})

data/lib/europeana/api/version.rb

@@ -2,6 +2,6 @@ module Europeana
   ##
   # Sets the *gem* version (not the *API* version)
   module API
-    VERSION = '0.3.3'
+    VERSION = '0.3.4'
   end
 end

data/spec/europeana/api/search_spec.rb

@@ -84,6 +84,14 @@ module Europeana
         subject { described_class.new(params).execute }
         it_behaves_like "search request"
       end
+
+      describe '.escape' do
+        %w<\\ + - & | ! ( ) { } [ ] ^ " ~ * ? : />.map do |char|
+          it "escapes lucene special character #{char}" do
+            expect(described_class.escape(char)).to eq("\\#{char}")
+          end
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,11 @@
+require 'coveralls'
 require 'europeana/api'
 require 'webmock/rspec'
 
 Dir["./spec/support/**/*.rb"].each { |f| require f }
 
+Coveralls.wear! unless Coveralls.will_run?.nil?
+
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect

data/spec/support/shared_examples/search_request.rb

@@ -1,12 +1,12 @@
-shared_examples "search request" do
+shared_examples 'search request' do
   before(:each) do
     stub_request(:get, %r{www.europeana.eu/api/v2/search.json}).
       to_return(body: '{"success":true}')
   end
 
-  it_behaves_like "API request"
+  it_behaves_like 'API request'
 
-  context "with API key" do
+  context 'with API key' do
     let(:api_key) { 'xyz' }
     let(:params) { {} }
 
@@ -14,26 +14,27 @@ shared_examples "search request" do
       Europeana::API.api_key = api_key
     end
 
-    it "sends a Search request to the API" do
+    it 'sends a Search request to the API' do
       subject
       expect(a_request(:get, %r{www.europeana.eu/api/v2/search.json})).
         to have_been_made.once
     end
 
-    context "without query" do
-      it "sets an empty query" do
+    context 'without query' do
+      it 'sends without query' do
         subject
-        expect(a_request(:get, %r{www.europeana.eu/api/v2/search.json?query=})).
+        expect(a_request(:get, %r{www.europeana.eu/api/v2/search.json})).
           to have_been_made.once
       end
     end
 
-    context "with query" do
+    context 'with query' do
       let(:params) { { query: 'test' } }
 
-      it "sends query" do
+      it 'sends query' do
         subject
-        expect(a_request(:get, %r{www.europeana.eu/api/v2/search.json?query=test})).
+        expect(a_request(:get, 'www.europeana.eu/api/v2/search.json').
+          with(query: hash_including({'query' => params[:query]}))).
           to have_been_made.once
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: europeana-api
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Richard Doe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport