ispras-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f10f112cfc9a3924c9cf8bf116021c729abe3cf
-  data.tar.gz: 36a927f5626900143c4f73d275594054f530c182
+  metadata.gz: e449c82286ed12e288982e5f15bebb36520e9dad
+  data.tar.gz: c2c03c668c022656a79a6075bd7e69b8b9eab601
 SHA512:
-  metadata.gz: 8df322ae6e16aed3d645a25c7b9522abdafd0a9362b8ac11091814036556a5e503cb144f8282ea0f5a676a530ebbb5c04c32566aef36af2ca884ddf57ba8f475
-  data.tar.gz: eee296f802c0090c88a784acd22b81f05c6071de17b79e461261e5c7a522a2649bcb2efed0ceb79d505bc2ac76f1592d7451427cc2113b1c5a353d2760cf9b67
+  metadata.gz: f411e73d35a44359a2f8166abbe48299666b732691c2de81a59f6bacec8bf3fcb3080ec982a1c21b1e0909e52cbd22c6963abe5f67b84d25295a22006f8ca294
+  data.tar.gz: 36cfabae4abe35c92b4505875a277d31ad15cf637520641b2cc738a313e2e4b27c538667ad1a0626fc35a412657fb36afe851e57415ef22d58e01a598af4253b

data/README.md

@@ -0,0 +1,24 @@
+# Ruby wrapper for [ISPRAS API](https://api.ispras.ru/)
+
+## Installation
+It's simple gem, so ```gem install ispras-api``` and adding ```gem 'ipras-api'``` should work.
+
+## Usage
+
+Currently wraps *texterra* and *twitter-nlp* services, so apikey for any of those is needed
+
+Code should look similar to this:
+```ruby
+require 'ispras-api'
+
+texterra = TexterraAPI.new 'APIKEY'
+text = 'Apple today updated iMac to bring numerous high-performance enhancements to the leading all-in-one desktop.'
+
+key_concepts = texterra.key_concepts text
+puts key_concepts[0]
+# > {:id=>"21492980", :kbname=>"enwiki", :title=>"IMac", :weight=>"0.35956284403800964"}
+
+wiki_url = texterra.get_attributes('21492980:enwiki', 'url(en)')[:elements][:object][:attributes][:i_attribute][:url]
+# > "http://en.m.wikipedia.org/wiki/IMac" 
+```
+Don't forget to check [REST documentation](https://api.ispras.ru/dev/rest) 

data/lib/ispras-api/ispras_api.rb

@@ -6,13 +6,11 @@ class IsprasAPI
   include HTTParty
   # debug_output $stdout
   ROOT_URL = 'api.ispras.ru/%s/%s'
-  parser Proc.new { |data| data }
 
   def initialize(key, name, ver)
     if key && key.size == 40
       self.class.base_uri ROOT_URL % [name, ver]
       self.class.default_params apikey: key
-      @nori = Nori.new(parser: :rexml, convert_tags_to: lambda { |tag| tag.snakecase.to_sym })
     else
       raise ApiError, 'Please provide proper apikey'
     end
@@ -21,15 +19,13 @@ class IsprasAPI
   def GET(path='', params={})
     options = { query: params }
     response = self.class.get "/#{path}", options
-    check_error response unless response.code == 200
-    hash = @nori.parse response.body
+    response.code == 200 ? response.parsed_response : check_error(response)
   end
 
   def POST(path='', params={}, form={})
     options = { query: params, body: form }
     response = self.class.post "/#{path}", options
-    check_error response unless response.code == 200
-    hash = @nori.parse response.body
+    response.code == 200 ? response.parsed_response : check_error(response)
   end
 
   private 

data/lib/ispras-api/texterra_api.rb

@@ -7,8 +7,10 @@ class TexterraAPI < IsprasAPI
   # Note that NLP methods return annotations only
   include TexterraNLP, TexterraKBM
   disable_rails_query_string_format
+  nori = Nori.new(parser: :rexml, convert_tags_to: lambda { |tag| tag.snakecase.to_sym })
+  parser Proc.new { |data| nori.parse data }
 
-  def initialize(key, name, ver)
+  def initialize(key, name=nil, ver=nil)
     name='texterra' if name.nil? || name.empty?
     ver='v3.1' if ver.nil? || ver.empty?
     super(key, name, ver)
@@ -78,7 +80,7 @@ class TexterraAPI < IsprasAPI
   private
 
     def check_error(response)
-      hash = @nori.parse response.body
+      hash = response.parsed_response
       er_node = hash[:html][:body][:p].detect { |node| node.is_a? Hash and node[:b] == 'root cause' }
       raise ApiError, er_node[:pre].gsub(/ru\.ispras.*:\s*/, '')
     end

data/lib/ispras-api/twitter_api.rb

@@ -3,8 +3,10 @@ require_relative './ispras_api'
 class TwitterAPI < IsprasAPI
   #This class provides methods to work with Twitter NLP REST via OpenAPI
   disable_rails_query_string_format
+  nori = Nori.new(parser: :rexml, convert_tags_to: lambda { |tag| tag.snakecase.to_sym })
+  parser Proc.new { |data| nori.parse data }
 
-  def initialize(key, name, ver)
+  def initialize(key, name=nil, ver=nil)
     name='twitter-nlp' if name.nil? || name.empty?
     ver='1.0' if ver.nil? || ver.empty?
     super(key, name, ver)
@@ -31,7 +33,7 @@ class TwitterAPI < IsprasAPI
   private
 
     def check_error(response)
-      hash = @nori.parse response.body
+      hash = response.parsed_response
       er_node = hash[:html][:body][:p].detect { |node| node.is_a? Hash and node[:b] == 'root cause' }
       raise ApiError, er_node[:pre].gsub(/ru\.ispras.*:\s*/, '')
     end

data/lib/ispras-api/version.rb

@@ -2,12 +2,12 @@ module Version
 
   MAJOR = 0
   MINOR = 1
-  PATCH = 1
+  PATCH = 2
   PRE = nil
   
   YEAR = "2015"
   MONTH = "02"
-  DAY = "10"
+  DAY = "11"
 
   def self.to_s
     [MAJOR, MINOR, PATCH, PRE].compact.join(".")

data/test/test_twitter_api.rb

@@ -10,6 +10,7 @@ class TestTwitterAPI < Minitest::Test
   end  
 
   def test_extract_dde
-    @twitter.extract_dde lang: 'en', username: 'Ann', screenname: 'bob', description: 'I am Ann from NY', tweet:'Hi there, I am Ann fromNY'
+    req = { lang: 'en', username: 'Ann', screenname: 'bob', description: 'I am Ann from NY', tweet:'Hi there, I am Ann fromNY' }
+    assert_instance_of Hash, @twitter.extract_dde(req)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ispras-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Alexey Laguta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -87,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- README.md
 - Rakefile
 - ispras-api.gemspec
 - lib/ispras-api.rb