inquisitio 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 7e07cc53ffa7b5cdb0d8b62c7f3afb38bec99b97
-  data.tar.gz: a954c3e4223e0b3df9a30271274d482ba793fb01
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjQ5Y2RhNzkxM2MwZmE5OTVmY2FkYjI0NGJmNDFlY2JkM2Q5ZmE5NQ==
+  data.tar.gz: !binary |-
+    NzE0OWNkZjkwZTk5M2VmZjQyOWIxOWYxNGUwMjBlZjhmNjlhZTc4MA==
 SHA512:
-  metadata.gz: 0037bcd1d4993960e3af1191d986b508000bc84f80c757c2db54097ee6a24bad66f17bf2a0190135ec53d1938cc46e1241d259edce2e8a8fb616830f6a6bf013
-  data.tar.gz: 76f5cec6d4ae58d2d9606f1e079cf92e0a05804da798b19375fbefedf7106cad4ecea23b2538bf835dc63728430bd5a80849d1202688427bcd3e443fc6628649
+  metadata.gz: !binary |-
+    ZTM0NWJmMjlmMTNmYjZlZDFkMTdhMzI2OTNmZmUzZDA4OWJkOTljYTk0OTYw
+    Mjk3ODBiNWVjMjZjOTA5ZWZlOGI2MDcwZjE2NWI1M2I3N2ZhMmJlYjY0ZTY2
+    NzZhNjA1MTZlY2Y1NzA2NzAyMDU1OTM0NWNkNGZmZTMxZTZiMGI=
+  data.tar.gz: !binary |-
+    ZWUwMzViZjJhMDQ3MjllY2NiOTc4MzY0MWNkZGI2MmYzN2M0NDNmMjg2MjRk
+    YzMyOTMzYjM5ZTUzNGI2ZDBkYmNiNmQwOWM4ZWY0ZjMyZjJmNTYyZTAwOWMx
+    Y2ZmMWEyNzZjOTZiOTlkNjZlOTk1MDJhZTYwZjdkNTE5MjMzOWU=

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.1.7 / 2013-12-13
+
+[FEATURE] Added dry-run configuration option to prevent data being sent to 
+          CloudSearch when indexing.
+
 0.1.6 / 2013-11-05
 
 [BUGFIX] Correctly ignore nil fields when indexing.

data/README.md

@@ -20,7 +20,7 @@ And then execute:
 
 This gem allows you to build and execute queries to run against Amazon Cloud Search.
 
-```
+```ruby
 results = Inquisitio.where("foobar").per(10).page(2).with(facet: 'thingy')
 results.each do |result|
   # ...

data/lib/inquisitio/configuration.rb

@@ -9,12 +9,15 @@ module Inquisitio
       :search_endpoint,
       :document_endpoint,
       :default_search_size,
+      :dry_run,
       :logger
     ]
+    
     attr_writer *SETTINGS
 
     def initialize
       self.logger = Inquisitio::Logger.new
+      self.dry_run = false
     end
 
     SETTINGS.each do |setting|
@@ -26,8 +29,8 @@ module Inquisitio
     private
 
     def get_or_raise(setting)
-      instance_variable_get("@#{setting.to_s}") || 
-        raise(InquisitioConfigurationError.new("Configuration for #{setting} is not set"))
+      val = instance_variable_get("@#{setting.to_s}")
+      val.nil?? raise(InquisitioConfigurationError.new("Configuration for #{setting} is not set")) : val
     end
   end
 end

data/lib/inquisitio/indexer.rb

@@ -16,12 +16,11 @@ module Inquisitio
 
     def index
       Inquisitio.config.logger.info "Indexer posting to #{batch_index_url} body: #{body}"
-      response = Excon.post(batch_index_url,
-                           :body => body,
-                           :headers => {"Content-Type" =>"application/json"})
-      Inquisitio.config.logger.info "Response - status: #{response.status} body: #{response.body}"
-      raise InquisitioError.new("Index failed with status code: #{response.status} Message: #{response.body}") unless response.status == 200
-      response.body
+      if Inquisitio.config.dry_run
+        Inquisitio.config.logger.info "Skipping POST as running in dry-run mode"
+      else
+        post_to_endpoint
+      end
     end
 
     private
@@ -34,5 +33,15 @@ module Inquisitio
     def batch_index_url
       "#{Inquisitio.config.document_endpoint}/2011-02-01/documents/batch"
     end
+      
+    def post_to_endpoint
+      response = Excon.post(batch_index_url,
+                           :body => body,
+                           :headers => {"Content-Type" =>"application/json"})
+      Inquisitio.config.logger.info "Response - status: #{response.status} body: #{response.body}"
+      raise InquisitioError.new("Index failed with status code: #{response.status} Message: #{response.body}") unless response.status == 200
+      response.body
+    end    
+    
   end
 end

data/lib/inquisitio/version.rb

@@ -1,3 +1,3 @@
 module Inquisitio
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/test/configuration_test.rb

@@ -54,6 +54,19 @@ module Inquisitio
         Inquisitio.config.default_search_size
       end
     end
+
+    def test_logger_is_configured_by_default
+      assert_kind_of Inquisitio::Logger, Inquisitio.config.logger
+    end
+
+    def test_dry_run_disabled_by_default
+      refute Inquisitio.config.dry_run
+    end
+    
+    def test_enable_dry_run
+      Inquisitio.config.dry_run = true
+      assert Inquisitio.config.dry_run
+    end
   end
 end
 

data/test/indexer_test.rb

@@ -7,6 +7,8 @@ module Inquisitio
       Inquisitio.config.document_endpoint = @document_endpoint
     #def initialize(type, id, version, fields)
       @documents = [Document.new("add", "12345", 1, {})]
+      
+      Inquisitio.config.dry_run = false      
     end
 
     def teardown
@@ -70,5 +72,15 @@ module Inquisitio
       response = indexer.index
       assert_equal body, response
     end
+
+    def test_index_does_not_post_when_in_dry_run_mode
+      Excon.defaults[:mock] = true
+      
+      Inquisitio.config.dry_run = true
+      
+      indexer = Indexer.new(@documents)
+      response = indexer.index
+      assert response.nil?
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inquisitio
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Jeremy Walker
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -30,14 +30,14 @@ dependencies:
   name: ruby_deep_clone
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -58,42 +58,42 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -165,17 +165,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: This wraps AWS CloudSearch in a Ruby Gem