indextank 0.0.6 → 1.0.7

data/lib/indextank.rb

@@ -5,7 +5,7 @@ directory = File.expand_path(File.dirname(__FILE__))
 require File.join(directory, 'indextank', 'client')
 
 module IndexTank
-  VERSION = "0.0.6"
+  VERSION = "1.0.7"
 
   def self.setup_connection(url, &block)
     @conn = Faraday::Connection.new(:url => url) do |builder|
@@ -17,6 +17,7 @@ module IndexTank
     end
     @uri = URI.parse(url)
     @conn.basic_auth @uri.user,@uri.password
+    @conn.headers['User-Agent'] = "IndexTank-Ruby/#{VERSION}"
     @conn
   end
 end

data/lib/indextank/client.rb

@@ -7,7 +7,8 @@ module IndexTank
 
     def initialize(api_url)
       @uri = api_url
-      @conn = IndexTank.setup_connection(api_url)
+      builder = Proc.new { |builder| builder.use ClientResponseMiddleware }
+      @conn = IndexTank.setup_connection(api_url, &builder)
     end
 
     def indexes(name = nil)
@@ -33,4 +34,26 @@ module IndexTank
       Index.new("#{@uri}/v1/indexes/#{name}")
     end
   end
+
+  class ClientResponseMiddleware < Faraday::Response::Middleware
+    def self.register_on_complete(env)
+      env[:response].on_complete do |finished_env|
+        case finished_env[:status]
+        when 200
+          nil # this is the expected return code
+        when 204
+          nil # this is the expected return code for empty responses
+        when 401
+          raise InvalidApiKey
+        else
+          raise UnexpectedHTTPException, finished_env[:body]
+        end
+      end
+    end
+
+    def initialize(app)
+      super
+      @parser = nil
+    end
+  end
 end

data/lib/indextank/document.rb

@@ -5,7 +5,9 @@ module IndexTank
   class Document
     attr_reader :docid
 
+    # :docid => a String or Symbol, that is no longer than 1024 bytes when UTF-8 encoded
     def initialize(document_url, docid)
+      raise InvalidArgument , "docid too long. max is 1024 bytes and got #{String(docid).bytesize}" unless String(docid).bytesize <= 1024
       @docid = docid
       builder = Proc.new { |builder| builder.use DocumentResponseMiddleware }
       @conn  = IndexTank.setup_connection(document_url, &builder)
@@ -65,6 +67,10 @@ module IndexTank
     def self.register_on_complete(env)
       env[:response].on_complete do |finished_env|
         case finished_env[:status]
+        when 200
+          nil # this is the expected code
+        when 204
+          nil # this is another expected code, for empty responses
         when 401
           raise InvalidApiKey
         when 409
@@ -73,6 +79,8 @@ module IndexTank
           raise NonExistentIndex
         when 400
           raise InvalidArgument, finished_env[:body]
+        else
+          raise UnexpectedHTTPException, finished_env[:body]
         end
       end
     end

data/lib/indextank/exceptions.rb

@@ -7,4 +7,5 @@ module IndexTank
   class InvalidQuery < StandardError; end
   class IndexInitializing < StandardError; end
   class InvalidArgument < StandardError; end
+  class UnexpectedHTTPException < StandardError; end
 end

data/lib/indextank/index.rb

@@ -155,6 +155,8 @@ module IndexTank
       end
     end
 
+    # creates a new document, identified by :docid
+    # :docid => a String or Symbol, with bytesize no longer than 1024 bytes
     def document(docid)
       Document.new("#{@uri}/docs", docid)
     end

metadata

@@ -1,21 +1,23 @@
 --- !ruby/object:Gem::Specification 
 name: indextank
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
+  - 1
   - 0
-  - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 1.0.7
 platform: ruby
 authors: 
 - Santiago Perez
 - Terence Lee
+- Diego Buthay
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-04 00:00:00 -03:00
+date: 2011-01-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,8 +26,9 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 4
@@ -41,6 +44,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 62196421
         segments: 
         - 2
         - 0
@@ -58,6 +62,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 62196421
         segments: 
         - 2
         - 0
@@ -73,8 +78,9 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 33
         segments: 
         - 0
         - 10
@@ -88,8 +94,9 @@ dependencies:
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 8
@@ -105,6 +112,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -116,8 +124,9 @@ dependencies:
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 0
         - 3
@@ -133,6 +142,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -144,8 +154,9 @@ dependencies:
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 0
         - 7
@@ -159,8 +170,9 @@ dependencies:
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
         segments: 
         - 1
         - 4
@@ -172,6 +184,7 @@ description: Ruby Client for the IndexTank API
 email: 
 - santip@santip.com.ar
 - hone02@gmail.com
+- dbuthay@gmail.com
 executables: []
 
 extensions: []
@@ -204,6 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -212,13 +226,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: nowarning
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Ruby Client for the IndexTank API