cro 1.0.3 → 1.1.3

data/README.md

@@ -15,13 +15,20 @@ Configure your API details:
 	CRO::Config.email = "Your email address"
 	CRO::Config.api_key = "Your API key"
 	
+## Search for a company
+
 You can then search on companies with
 
-	CRO::API.new.search("Company Name")
+	CRO::API.new.search("Company Name", search_type)
+	
+The different search_types are:
+1 = Exact match (will give very few results usually)
+2 = Starts with this phrase (default)
+3 = Contains this phrase (slowest, but more results)
 	
 This will then return an array of results which you can access for example:
 
-	@results = CRO::API.new.search("Starbucks")
+	@results = CRO::API.new.search("Starbucks", 3)
 	@results.each do |result|
 		puts result["company_name"]
 	end
@@ -30,7 +37,9 @@ This will then return an array of results which you can access for example:
 	# STARBUCKS COFFEE COMPANY (IRELAND) LIMITED
 	# STARBUCKS COFFEE CORPORATION LIMITED
 	# STARBUCKS COFFEE SHOPS LIMITED
-	
+
+## Search for a company's official submissions
+
 You can also search on company submissions for offical documents. The company type is defined as "c" for company or "b" for business with the CRO.
 
 	CRO::API.new.submissions("company_number", "company_type")
@@ -43,15 +52,23 @@ An example of which:
 	  puts submission["sub_type_desc"]
 	end
 	
-	# Results
-	# B10 CHANGE IN DIRECTOR OR SECRETARY
-	# B5 RETURN OF ALLOTMENTS
-	# G2- OR INCREASE IN NOMINAL SHARE
-	# G2- OR INCREASE IN NOMINAL SHARE
-	# G2- OR INCREASE IN NOMINAL SHARE
+	-> B10 CHANGE IN DIRECTOR OR SECRETARY
+	-> B5 RETURN OF ALLOTMENTS
+	-> G2- OR INCREASE IN NOMINAL SHARE
+	-> G2- OR INCREASE IN NOMINAL SHARE
+	-> G2- OR INCREASE IN NOMINAL SHARE
 	
 These all currently return json results from the response.
 
+## View a submission in detail
+
+You can view more details about any one submission with:
+
+	@submission = CRO::API.new.get_submission("6191121", "2")
+	puts @submission["scan_date"]
+	
+	-> "2008-11-01T08:54:43Z"
+
 ## Contributing to cro
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.1.3

data/cro.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "cro"
-  s.version = "1.0.3"
+  s.version = "1.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Kenny"]
-  s.date = "2012-05-01"
+  s.date = "2012-05-02"
   s.description = "A ruby gem that allows you to easily integrate with the Irish Companies Registration Offices API."
   s.email = "brian@minicorp.ie"
   s.extra_rdoc_files = [

data/lib/cro/api.rb

@@ -5,14 +5,16 @@ module CRO
       @auth = {:username => "#{CRO::Config.email}", :password => "#{CRO::Config.api_key}"}
     end
 
-    def search(company_name)
-      @results = HTTParty.get(URI.escape(@@uri + "/companies?company_name=#{company_name}&searchType=3&format=json"), :basic_auth => @auth)
-      return @results
+    def search(company_name, search_type)
+      HTTParty.get(URI.escape(@@uri + "/companies?company_name=#{company_name}&searchType=#{search_type}&company_bus_ind=E&format=json"), :basic_auth => @auth)
     end
 
     def submissions(company_num, company_type)
-      @results = HTTParty.get(@@uri + "/submissions?company_bus_ind=" + company_type + "&company_num=" + company_num + "&format=json", :basic_auth => @auth)
-      return @results
+      HTTParty.get(@@uri + "/submissions?company_bus_ind=" + company_type + "&company_num=" + company_num + "&format=json", :basic_auth => @auth)
+    end
+    
+    def get_submission(sub_num, doc_num)
+      HTTParty.get(@@uri + "/submission/" + sub_num + "/" + doc_num + "?format=json&htmlEnc=1", :basic_auth => @auth)
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cro
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 21
   prerelease: 
   segments: 
   - 1
-  - 0
+  - 1
   - 3
-  version: 1.0.3
+  version: 1.1.3
 platform: ruby
 authors: 
 - Brian Kenny
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-01 00:00:00 Z
+date: 2012-05-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement