nerdier 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +34 -0
- data/Rakefile +1 -0
- data/lib/nerdier/client.rb +8 -0
- data/lib/nerdier/nerd.rb +35 -0
- data/lib/nerdier/version.rb +3 -0
- data/lib/nerdier.rb +7 -0
- data/nerdier.gemspec +23 -0
- metadata +103 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 Max De Marzi
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
# Nerdier
|
2
|
+
|
3
|
+
It is a ruby gem which provides an interface to NERD http://nerd.eurecom.fr
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'nerdier'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install nerdier
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
export NERD_API="your nerd api"
|
22
|
+
bundle exec irb
|
23
|
+
require 'nerdier'
|
24
|
+
nerd = Nerdier::Nerd.new
|
25
|
+
entities = nerd.extract("http://www.bbc.co.uk/news/uk-england-london-22385389")
|
26
|
+
|
27
|
+
|
28
|
+
## Contributing
|
29
|
+
|
30
|
+
1. Fork it
|
31
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
32
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
33
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
34
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
data/lib/nerdier/nerd.rb
ADDED
@@ -0,0 +1,35 @@
|
|
1
|
+
module Nerdier
|
2
|
+
|
3
|
+
class Nerd
|
4
|
+
USER_AGENT = "NERD ruby library #{VERSION}"
|
5
|
+
|
6
|
+
attr_accessor :url, :api, :timeout
|
7
|
+
|
8
|
+
def initialize(api = ENV['NERD_API'], url = 'http://nerd.eurecom.fr', timeout = 30)
|
9
|
+
@client = Client.http_client
|
10
|
+
@url = url
|
11
|
+
@timeout = timeout
|
12
|
+
@options = {:key => api}
|
13
|
+
@headers = {:"content-type" => "application/x-www-form-urlencoded",
|
14
|
+
:accept => "application/json",
|
15
|
+
:"user-agent" => USER_AGENT}
|
16
|
+
end
|
17
|
+
|
18
|
+
def extract(uri = "", extractor = 'combined', timeout = @timeout)
|
19
|
+
# Submit Document
|
20
|
+
doc = Oj.load(@client.post_content(@url + "/api/document", {:body => @options.merge({:uri => uri}) , :headers => @headers}))
|
21
|
+
doc_id = doc["idDocument"]
|
22
|
+
|
23
|
+
# Annotate Document
|
24
|
+
annotated_options = @options.merge({"extractor" => extractor, "idDocument" => doc_id, :timeout => @timeout})
|
25
|
+
annotated_doc = Oj.load(@client.post_content(@url + "/api/annotation", {:body => annotated_options, :headers => @headers}))
|
26
|
+
annotation_id = annotated_doc["idAnnotation"]
|
27
|
+
|
28
|
+
# Extract from Document
|
29
|
+
extract_options = @options.merge(:idAnnotation => annotation_id) #.map{|k,v| "#{k}=#{v}"}.join("&")
|
30
|
+
Oj.load(@client.get_content(@url + "/api/entity", {:query => extract_options, :headers => @headers}))
|
31
|
+
end
|
32
|
+
|
33
|
+
|
34
|
+
end
|
35
|
+
end
|
data/lib/nerdier.rb
ADDED
data/nerdier.gemspec
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'nerdier/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |gem|
|
7
|
+
gem.name = "nerdier"
|
8
|
+
gem.version = Nerdier::VERSION
|
9
|
+
gem.authors = ["Max De Marzi"]
|
10
|
+
gem.email = ["maxdemarzi@hotmail.com"]
|
11
|
+
gem.description = "A Ruby Wrapper for the NERD REST API"
|
12
|
+
gem.summary = "It is a ruby gem which provides an interface to NERD http://nerd.eurecom.fr"
|
13
|
+
gem.homepage = "https://github.com/maxdemarzi/nerdier"
|
14
|
+
|
15
|
+
gem.files = `git ls-files`.split($/)
|
16
|
+
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
|
17
|
+
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
|
18
|
+
gem.require_paths = ["lib"]
|
19
|
+
|
20
|
+
gem.add_dependency "httpclient", ">= 2.3.3"
|
21
|
+
gem.add_dependency "json", ">= 1.6.0"
|
22
|
+
gem.add_dependency "oj", ">= 2.0.12"
|
23
|
+
end
|
metadata
ADDED
@@ -0,0 +1,103 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: nerdier
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Max De Marzi
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-05-03 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: httpclient
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: 2.3.3
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 2.3.3
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: json
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: 1.6.0
|
38
|
+
type: :runtime
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: 1.6.0
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: oj
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: 2.0.12
|
54
|
+
type: :runtime
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 2.0.12
|
62
|
+
description: A Ruby Wrapper for the NERD REST API
|
63
|
+
email:
|
64
|
+
- maxdemarzi@hotmail.com
|
65
|
+
executables: []
|
66
|
+
extensions: []
|
67
|
+
extra_rdoc_files: []
|
68
|
+
files:
|
69
|
+
- .gitignore
|
70
|
+
- Gemfile
|
71
|
+
- LICENSE.txt
|
72
|
+
- README.md
|
73
|
+
- Rakefile
|
74
|
+
- lib/nerdier.rb
|
75
|
+
- lib/nerdier/client.rb
|
76
|
+
- lib/nerdier/nerd.rb
|
77
|
+
- lib/nerdier/version.rb
|
78
|
+
- nerdier.gemspec
|
79
|
+
homepage: https://github.com/maxdemarzi/nerdier
|
80
|
+
licenses: []
|
81
|
+
post_install_message:
|
82
|
+
rdoc_options: []
|
83
|
+
require_paths:
|
84
|
+
- lib
|
85
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
86
|
+
none: false
|
87
|
+
requirements:
|
88
|
+
- - ! '>='
|
89
|
+
- !ruby/object:Gem::Version
|
90
|
+
version: '0'
|
91
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
92
|
+
none: false
|
93
|
+
requirements:
|
94
|
+
- - ! '>='
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
requirements: []
|
98
|
+
rubyforge_project:
|
99
|
+
rubygems_version: 1.8.24
|
100
|
+
signing_key:
|
101
|
+
specification_version: 3
|
102
|
+
summary: It is a ruby gem which provides an interface to NERD http://nerd.eurecom.fr
|
103
|
+
test_files: []
|