guidestar 0.1.1 → 0.1.2

data/README.md

@@ -22,17 +22,43 @@ Then configure it with an initializer like `/config/initializers/guidestar.rb`:
 
 Once you initialize it, you can use it in your code via:
 
+    results = Guidestar.search(:keyword => 'monkeys', :limit => 20)
+
+Or you can create a Guidestar::Client object and go from there:
+
     client  = Guidestar::Client.new
     results = client.search(:keyword => 'monkeys', :limit => 20)
+    # OR
+    results = client.keyword('monkeys').per(20).search
+    # or any combination of the above methods
+
+There are four main API methods that you can use:
+
+    Guidestar.search            # this is the only tested method on this repo
+    Guidestar.detailed_search
+    Guidestar.charity_check
+    Guidestar.npo_validation
+
+See https://gsservices.guidestar.org/GuideStar_SearchService/WebServiceSearchQuery.xsd
+for detailed search parameters.
+
+The Guidestar::Result object behaves like an array, but includes some extra
+fields for your usage:
 
     results.xml
     # => raw xml data
 
     results.search_time
     # => 0.12
+
     results.total_count
     # => 1292
 
+    results.total_pages
+    # => 52
+
+You can iterate through the results like any Enumerable:
+
     results.each do |org|
       org.name
       # => 'Monkey Paradise'
@@ -46,14 +72,15 @@ Once you initialize it, you can use it in your code via:
 
 For getting the next page of results, it behaves similarly to kaminari or will_paginate:
 
-    results.per(50).page(2).each { |more_orgs| puts more_orgs.name }
+    results.page(2).each { |more_orgs| puts more_orgs.name }
 
-If you need more direct access to the array of results, just hit:
+If you should ever need direct access to the array of results, just hit:
 
     results.organizations
 
-The way you use it is all super-flexible.  You can pass in your options beforehand or
-chain them along the way.
+Ruby APIs should be super flexible in usage, so this gem lets you access the
+data how you want.  Pass in your options all at once or chain them.  Create a new
+search or use the result to paginate or adjust the search as needed.
 
 ## Contributing
 

data/lib/guidestar.rb

@@ -18,7 +18,7 @@ module Guidestar
     end
 
     def method_missing(method_name, *args)
-      Guidestar::Client.new.send(method_name.to_sym, *args)
+      Guidestar::Chain.new.send(method_name.to_sym, *args)
     end
   end
 

data/lib/guidestar/version.rb

@@ -1,3 +1,3 @@
 module Guidestar
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guidestar
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors: