gini-api 0.9.8 → 0.9.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80c9d8ad0c0fc68dbbc20a990cb40e3e9f60cec7
-  data.tar.gz: 3f8a4c2cfd1f2e6c7064be4c0faa36747f2c7084
+  metadata.gz: f482221a91704b834f741e93bc66ed8d387f673b
+  data.tar.gz: 7cabfa0aa95303038767caf0058ac02e6684d9cc
 SHA512:
-  metadata.gz: 9f1b0d52409011c3edc7499324032ac25f9fed96d2df59d3fcf8ab7d0d4ac0a418e5e018cc706f62a61adc1c54243e77e5e90d0e879cb7e4193b9f77a461f130
-  data.tar.gz: b47646a4ee76a5a0d48c9012f6c80e40b1bee32337beaeeaaf7fb31ded6923158f61a67b72dda0b9679d91c2ab3a970f2bff0873be5ebf144b47dca4cb7817ea
+  metadata.gz: 0819422ce704bd75d4ef24b46ee3566a980453e79819f541312cd6c08a49477f5178c2e7da36eda92c9c541b6dd4b2370ca2e57013c3974ae45477bf7d385c4e
+  data.tar.gz: b068d3ef18cf8daa7c9514c85c0fd69004e83f65c0f84f6b8bd4189a0589cfcf17b43ce7ab53366ffec32c201eee5b41d979343a9d767e88b4790a8f13144321

data/.gitignore

@@ -4,4 +4,3 @@ pkg
 vendor
 spec/reports
 .yardoc
-Gemfile.lock

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    gini-api (0.9.9)
+      logger
+      oauth2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    ci_reporter (2.0.0)
+      builder (>= 2.1.2)
+    ci_reporter_rspec (1.0.0)
+      ci_reporter (~> 2.0)
+      rspec (>= 2.14, < 4)
+    coderay (1.1.0)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.6)
+    formatador (0.2.5)
+    guard (2.11.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.0)
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hitimes (1.2.2)
+    jwt (1.2.0)
+    listen (2.8.5)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    logger (1.2.8)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    mime-types (2.4.3)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nenv (0.1.1)
+    notiffany (0.0.2)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    slop (3.6.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    timers (4.0.1)
+      hitimes
+    tins (0.13.2)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  ci_reporter_rspec
+  coveralls
+  gini-api!
+  guard-rspec
+  pry
+  rake
+  redcarpet
+  rspec
+  simplecov
+  simplecov-rcov
+  webmock
+  yard

data/README.md

@@ -1,4 +1,4 @@
-<img src="https://www.gini.net/wp-content/uploads/2014/02/Gini-API_logo.svg" width="222" alt="Gini API logo" />
+<img src="https://www.gini.net/assets/gini_api_logo.svg" width="222" alt="Gini API logo" />
 
 # Gini API Ruby client
 
@@ -144,14 +144,18 @@ doc.extractions.candidates[:dates]
 # => Array of all found candidates
 doc.extractions.raw
 # => {:extractions=>{...
+doc.extractions.undefinedLabel
+# => nil
 ```
 
 ### Submitting feedback
 
 ```ruby
-doc.submit_feedback(:bic, 'XXXXXXXX')
-# => nil
-doc.submit_feedback(:unknownlabel, 'XXXXXXX')
+doc.extractions.bic = 'XXXXXXXX'
+# => 'XXXXXXXX'
+doc.extractions.bic = { value: 'XXXXXXXX', :box=>{:top=>2176.0, :left=>2000.0, :width=>173.0, :height=>50.0, :page=>1 }
+# => { value: 'XXXXXXXX', box: { top: 2176.0, left: 2000.0, width: 173.0, height: 50.0, page: 1 }
+doc.extractions.unknownLabel = 'XXXXXXXX'
 # => raises Gini::Api::DocumentError
 ```
 

data/lib/gini-api/document/extractions.rb

@@ -35,11 +35,9 @@ module Gini
 
         response.parsed[:extractions].each do |k,v|
           instance_variable_set("@#{k}", v)
-          self.class.send(:attr_reader, k)
         end
 
         instance_variable_set("@candidates", response.parsed[:candidates])
-        self.class.send(:attr_reader, :candidates)
       end
 
       # Get filed value for given extraction key
@@ -49,11 +47,66 @@ module Gini
       #
       def [](item)
         unless instance_variable_get("@#{item}")
-          raise Gini::Api::DocumentError.new("Invalid extraction key #{item}: Not found")
+          raise Gini::Api::DocumentError.new("Invalid extraction key '#{item}': Not found")
+        end
+
+        # method_missing requires some additional checks
+        label = instance_variable_get("@#{item}")
+
+        unless label.is_a? Hash and label.has_key? :value
+          raise Gini::Api::DocumentError.new("Extraction key '#{item}' has no :value defined")
         end
 
         instance_variable_get("@#{item}")[:value]
       end
+
+      # Submit feedback on extraction label
+      #
+      # @param [String] label Extraction label to submit feedback on
+      # @param [Hash] feedback Hash containing at least key :value (:box is optional)
+      #
+      def submit_feedback(label, feedback)
+        response = @api.request(
+          :put,
+          "#{@location}/#{label}",
+          headers: { 'content-type' => @api.version_header[:accept] },
+          body: feedback.to_json
+        )
+      rescue Gini::Api::RequestError => e
+        if e.api_status == 422
+          raise Gini::Api::DocumentError.new(
+            "Failed to submit feedback for label '#{label}' (code=#{e.api_status}, msg=#{e.api_response.body})",
+            response
+          )
+        end
+        raise
+      end
+
+      # Create setter and getter dynamically with method_missing
+      #
+      # @param [Symbol] m method name
+      # @param [Array] args method arguments
+      # @param [Block] block Block passed to the missing method
+      # @return [Hash, Nil] Return extraction hash or nil
+      #
+      def method_missing(m, *args, &block)
+        m_name = m.to_s
+        label = m_name.split('=')[0]
+
+        if m_name.end_with? '='
+          # setter method. Set instance variable and submit feedback
+          if args[0].is_a? Hash
+            feedback = args[0]
+          else
+            feedback = { value: args[0] }
+          end
+          instance_variable_set("@#{label}", feedback)
+          submit_feedback(label, feedback)
+        else
+          # getter. return instance variable or nil
+          instance_variable_get("@#{label}")
+        end
+      end
     end
   end
 end

data/lib/gini-api/document.rb

@@ -124,6 +124,7 @@ module Gini
 
       # Submit feedback on extraction label
       #
+      # @deprecated Use 'doc.extractions.LABEL = VALUE' instead. Will be removed in next version
       # @param [String] label Extraction label to submit feedback on
       # @param [String] value The new value for the given label
       #

data/lib/gini-api/version.rb

@@ -1,6 +1,6 @@
 module Gini
   module Api
     # Package version
-    VERSION = "0.9.8"
+    VERSION = "0.9.9"
   end
 end

data/spec/gini-api/client_spec.rb

@@ -267,7 +267,7 @@ describe Gini::Api::Client do
           headers: {
             location: 'LOC'
           },
-          body: {}
+          body: '{}'.to_json
         )
       end
 

data/spec/gini-api/document/extraction_spec.rb

@@ -47,7 +47,10 @@ describe Gini::Api::Document::Extractions do
             entity: 'date',
             value: '2012-06-20',
             candidates: 'dates'
-          }
+          },
+          invalid: {
+            this_is: 'wrong'
+          },
         },
         candidates: {
           dates: [
@@ -99,11 +102,20 @@ describe Gini::Api::Document::Extractions do
 
   describe '#[]' do
 
-    context 'with invalid key' do
+    context 'with missing key' do
 
       it 'raises exception' do
         expect { extractions[:unknown] }.to \
-          raise_error(Gini::Api::DocumentError, /Invalid extraction key unknown/)
+          raise_error(Gini::Api::DocumentError, /Invalid extraction key 'unknown'/)
+      end
+
+    end
+
+    context 'with missing :value in response' do
+
+      it 'raises exception' do
+        expect { extractions[:invalid] }.to \
+          raise_error(Gini::Api::DocumentError, /Extraction key 'invalid' has no :value defined/)
       end
 
     end
@@ -118,4 +130,92 @@ describe Gini::Api::Document::Extractions do
 
   end
 
+  describe '#method_missing' do
+
+    context 'with unknown extraction' do
+
+      context 'and only value' do
+
+        it 'will set instance variable to new hash' do
+          expect(extractions).to receive(:instance_variable_set).with('@test', {value: :test})
+          expect(extractions).to receive(:submit_feedback).with('test', {:value=>:test})
+          extractions.test = :test
+        end
+
+      end
+
+      context 'and hash' do
+
+        it 'will set instance variable to supplied hash' do
+          expect(extractions).to receive(:instance_variable_set).with('@test', {value: 'test', box: {}})
+          expect(extractions).to receive(:submit_feedback).with('test', {value: 'test', box: {}})
+          extractions.test = {value: 'test', box: {} }
+        end
+
+      end
+
+    end
+
+  end
+
+  describe '#submit_feedback' do
+
+    context 'with valid label' do
+
+      before do
+        allow(api.token).to receive(:put).with(
+          "#{location}/test",
+          {
+            headers: { 'content-type' => header },
+            body: { value: 'Johnny Bravo' }.to_json
+          }
+        ).and_return(OAuth2::Response.new(double('Response', status: 204)))
+      end
+
+      it 'succeeds' do
+        expect(extractions.submit_feedback(:test, {value: 'Johnny Bravo'})).to be_a(OAuth2::Response)
+      end
+
+    end
+
+    context 'with invalid label (http code 422)' do
+
+      before do
+        allow(api.token).to receive(:put).with(
+          "#{location}/test",
+          {
+            headers: { 'content-type' => header },
+            body: { value: 'Johnny Bravo' }.to_json
+          }
+        ).and_raise(Gini::Api::RequestError.new('dummy', double('xxx', status: 422, env: {}, body: {})))
+      end
+
+      it 'raises Gini::Api::DocumentError' do
+        expect{extractions.submit_feedback(:test, {value: 'Johnny Bravo'})}.to \
+        raise_error(Gini::Api::DocumentError, /Failed to submit feedback for label/)
+      end
+
+    end
+
+    context 'with undefined error' do
+
+      before do
+        allow(api.token).to receive(:put).with(
+          "#{location}/test",
+          {
+            headers: { 'content-type' => header },
+            body: { value: 'Johnny Bravo' }.to_json
+          }
+        ).and_raise(Gini::Api::RequestError.new('dummy', double('xxx', status: 500, env: {}, body: {})))
+      end
+
+      it 'raises Gini::Api::RequestError' do
+        expect{extractions.submit_feedback(:test, {value: 'Johnny Bravo'})}.to \
+        raise_error(Gini::Api::RequestError)
+      end
+
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gini-api
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.9.9
 platform: ruby
 authors:
 - Daniel Kerwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -217,6 +217,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - README.md
 - Rakefile