caseblocks_api 0.2.12 → 0.2.13

data/README.rdoc

@@ -8,7 +8,22 @@ Create a new Case:
 
 `caseblocks.create_case({:title => "This is a Case!", :due_at => "tomorrow")`
 
-Description goes here.
+Searching for cases:
+
+`caseblocks.search('CaseTypeName', {telephone_number: '12334', given_name: 'Smith'})`
+
+Searching with pagination:
+
+`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, page: 0, page_size: 10)`
+
+Searching with sorting:
+
+`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, sort_by: [{field: 'created_at', direction: 'desc'}])`
+`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, sort_by: [{field: 'created_at', direction: 'asc'}])`
+
+Searching for a reduced response:
+
+`caseblocks.search('CaseTypeName', {given_name: 'Smith'}, fields: ['id', 'given_name', ''created_at'}])`
 
 == Contributing to caseblocks_api
  

data/VERSION

@@ -1 +1 @@
-0.2.12
+0.2.13

data/caseblocks_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "caseblocks_api"
-  s.version = "0.2.12"
+  s.version = "0.2.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Provan"]
-  s.date = "2013-02-07"
+  s.date = "2013-02-19"
   s.email = "development@emergeadapt.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -29,13 +29,13 @@ Gem::Specification.new do |s|
     "lib/caseblocks_api.rb",
     "lib/caseblocks_api/authentication_exception.rb",
     "lib/caseblocks_api/bucket_results.rb",
-    "lib/caseblocks_api/finder.rb",
     "lib/caseblocks_api/get_cases.rb",
+    "lib/caseblocks_api/searcher.rb",
     "lib/caseblocks_api/update_case.rb",
     "spec/caseblocks_api_spec.rb",
     "spec/lib/caseblocks_api/bucket_results_spec.rb",
-    "spec/lib/caseblocks_api/find_case_by_property_spec.rb",
     "spec/lib/caseblocks_api/get_cases_spec.rb",
+    "spec/lib/caseblocks_api/searcher_spec.rb",
     "spec/lib/caseblocks_api/update_case_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/fake_http_party.rb"

data/lib/caseblocks_api.rb

@@ -5,7 +5,7 @@ require "caseblocks_api/authentication_exception"
 
 module CaseblocksAPI
   require 'caseblocks_api/bucket_results'
-  require 'caseblocks_api/finder'
+  require 'caseblocks_api/searcher'
   require 'caseblocks_api/update_case'
   require 'caseblocks_api/get_cases'
 

data/lib/caseblocks_api/searcher.rb

@@ -0,0 +1,21 @@
+require 'caseblocks_api'
+require 'active_support/inflector'
+
+module CaseblocksAPI
+  class Searcher
+    def initialize(client)
+       @client = client
+    end
+
+    def execute_search(case_type, criteria, options={})
+        body = {properties: criteria}.merge(options).to_json
+        @client.post("/case_blocks/#{case_type}/search", :body => body)
+    end
+  end
+
+  class Client
+    def search(case_type, criteria, options={})
+      Searcher.new(self.class).execute_search(case_type, criteria, options)
+    end
+  end
+end

data/spec/lib/caseblocks_api/get_cases_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe CaseblocksAPI::GetCases do
-
     it "should call the API with a list of ids" do
         ids = ['1', '2']
         client = double('client')

data/spec/lib/caseblocks_api/searcher_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe CaseblocksAPI::Searcher do
+
+  let(:client) { double('client') }
+  let(:finder) { CaseblocksAPI::Searcher.new(client) }
+  let(:case_type) { 'the_case_type' }
+
+  context "search with case type alone and empty properties" do
+      it "should pass them onto a POST request" do
+        expected_body = {body: {properties: {}}.to_json}
+        client.should_receive(:post).with("/case_blocks/#{case_type}/search", expected_body)
+        finder.execute_search(case_type, {})
+      end
+  end
+
+  context "search with case type with properties" do
+      it "should pass them onto a POST request" do
+        expected_body = {body: {properties: {order_number: '12334', client_surname: 'Smith'}}.to_json}
+        client.should_receive(:post).with("/case_blocks/#{case_type}/search", expected_body)
+        finder.execute_search(case_type, {order_number: '12334', client_surname: 'Smith'})
+      end
+  end
+
+  context "search with case type with properties and options" do
+      it "should pass them onto a POST request" do
+        expected_body = {body: {properties: {order_number: '12334', client_surname: 'Smith'}, page: 0, page_size: 10}.to_json}
+        client.should_receive(:post).with("/case_blocks/#{case_type}/search", expected_body)
+        finder.execute_search(case_type, {order_number: '12334', client_surname: 'Smith'}, page: 0, page_size: 10)
+      end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caseblocks_api
 version: !ruby/object:Gem::Version
-  version: 0.2.12
+  version: 0.2.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -192,13 +192,13 @@ files:
 - lib/caseblocks_api.rb
 - lib/caseblocks_api/authentication_exception.rb
 - lib/caseblocks_api/bucket_results.rb
-- lib/caseblocks_api/finder.rb
 - lib/caseblocks_api/get_cases.rb
+- lib/caseblocks_api/searcher.rb
 - lib/caseblocks_api/update_case.rb
 - spec/caseblocks_api_spec.rb
 - spec/lib/caseblocks_api/bucket_results_spec.rb
-- spec/lib/caseblocks_api/find_case_by_property_spec.rb
 - spec/lib/caseblocks_api/get_cases_spec.rb
+- spec/lib/caseblocks_api/searcher_spec.rb
 - spec/lib/caseblocks_api/update_case_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_http_party.rb
@@ -217,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -453322463455403595
+      hash: 2296649421097839558
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/lib/caseblocks_api/finder.rb

@@ -1,28 +0,0 @@
-require 'caseblocks_api'
-require 'active_support/inflector'
-
-module CaseblocksAPI
-  class Finder
-    def initialize(client)
-      @client = client
-    end
-
-    def execute_single(case_type, property_name, value, page, page_size)
-      @client.get("/case_blocks/#{case_type}/search", {query: {search: true, property: property_name, value: value, page: page, page_size: page_size}})
-    end
-
-    def execute_multiple(case_type, properties, page, page_size)
-      @client.post("/case_blocks/#{case_type}/search", :body => {search: true, properties: properties, page: page, page_size: page_size }.to_json)
-    end
-  end
-
-  class Client
-    def find_by_property(case_type, property_name, value, page, page_size)
-      Finder.new(self.class).execute_single(case_type, property_name, value, page, page_size)
-    end
-
-    def find_by_properties(case_type, properties, page, page_size)
-      Finder.new(self.class).execute_multiple(case_type, properties, page, page_size)
-    end
-  end
-end

data/spec/lib/caseblocks_api/find_case_by_property_spec.rb

@@ -1,31 +0,0 @@
-require 'spec_helper'
-
-
-describe CaseblocksAPI::Finder do
-
-  Given (:client) { FakeHttpParty.new }
-  Given (:case_type) { 'the_case_type' }
-
-  context "find by a single property" do
-    Given (:property_name) { "order_number" }
-    Given (:value) { "2000391" }
-    Given (:page) { "0" }
-    Given (:page_size) { "100" }
-    Given (:find_by_property) { CaseblocksAPI::Finder.new(client) }
-    When (:result) { find_by_property.execute_single(case_type, property_name, value, page, page_size) }
-    Then { expect(result).to eql client.result}
-    Then { expect(client.requested_url).to eql "/case_blocks/#{case_type}/search" }
-    Then { expect(client.params).to eql({query: {search: true, property: property_name, value: value, page: page, page_size: page_size}}) }
-  end
-
-  context "finding by multiple properties" do
-    Given (:properties) { {order_number: '12334', client_surname: 'Smith'} }
-    Given (:page) { "0" }
-    Given (:page_size) { "100" }
-    Given (:find_by_properties) { CaseblocksAPI::Finder.new(client) }
-    When (:result) { find_by_properties.execute_multiple(case_type, properties, page, page_size) }
-    Then { expect(client.requested_url).to eql "/case_blocks/#{case_type}/search" }
-    Then { expect(client.params).to eql({body: {search: true, properties: properties, page: page, page_size: page_size}.to_json}) }
-  end
-
-end