centralindex 0.0.2 → 0.0.3

data/lib/CentralIndex.rb

@@ -1,4 +1,6 @@
 require 'net/http'
+require "rubygems"
+require "json"
 
 # global to hold the api key
 $apiKey = ""
@@ -48,7 +50,12 @@ class CentralIndex
       request.set_form_data(params)
       retval = http.request(request)
     end
-    return retval.body
+    parsed = JSON.parse(retval.body)
+    if(parsed)
+      return parsed
+    else
+      return retval.body
+    end
   end
 
 
@@ -566,14 +573,13 @@ class CentralIndex
   #  @param longitude
   #  @param timezone
   #  @param telephone_number
-  #  @param telephone_type
   #  @param email
   #  @param website
   #  @param category_id
   #  @param category_name
   #  @return - the data from the api
   #
-  def putBusiness( name, address1, address2, address3, district, town, county, postcode, country, latitude, longitude, timezone, telephone_number, telephone_type, email, website, category_id, category_name)
+  def putBusiness( name, address1, address2, address3, district, town, county, postcode, country, latitude, longitude, timezone, telephone_number, email, website, category_id, category_name)
     params = Hash.new
     params['name'] = name
     params['address1'] = address1
@@ -588,7 +594,6 @@ class CentralIndex
     params['longitude'] = longitude
     params['timezone'] = timezone
     params['telephone_number'] = telephone_number
-    params['telephone_type'] = telephone_type
     params['email'] = email
     params['website'] = website
     params['category_id'] = category_id
@@ -600,12 +605,14 @@ class CentralIndex
   #
   # Provides a personalised URL to redirect a user to add an entity to Central Index
   #
-  #  @param language - The language to use to render the add path
+  #  @param language - The language to use to render the add path e.g. en
+  #  @param portal_name - The name of the website that data is to be added on e.g. YourLocal
   #  @return - the data from the api
   #
-  def getEntityAdd( language)
+  def getEntityAdd( language, portal_name)
     params = Hash.new
     params['language'] = language
+    params['portal_name'] = portal_name
     return doCurl("get","/entity/add",params)
   end
 
@@ -745,21 +752,13 @@ class CentralIndex
   #  @param entity_id
   #  @param number
   #  @param description
-  #  @param premium_rate
-  #  @param telephone_type
-  #  @param tps
-  #  @param ctps
   #  @return - the data from the api
   #
-  def postEntityPhone( entity_id, number, description, premium_rate, telephone_type, tps, ctps)
+  def postEntityPhone( entity_id, number, description)
     params = Hash.new
     params['entity_id'] = entity_id
     params['number'] = number
     params['description'] = description
-    params['premium_rate'] = premium_rate
-    params['telephone_type'] = telephone_type
-    params['tps'] = tps
-    params['ctps'] = ctps
     return doCurl("post","/entity/phone",params)
   end
 
@@ -785,15 +784,13 @@ class CentralIndex
   #  @param entity_id
   #  @param number
   #  @param description
-  #  @param premium_rate
   #  @return - the data from the api
   #
-  def postEntityFax( entity_id, number, description, premium_rate)
+  def postEntityFax( entity_id, number, description)
     params = Hash.new
     params['entity_id'] = entity_id
     params['number'] = number
     params['description'] = description
-    params['premium_rate'] = premium_rate
     return doCurl("post","/entity/fax",params)
   end
 
@@ -1133,6 +1130,21 @@ class CentralIndex
   end
 
 
+  #
+  # Format an address according to the rules of the country supplied
+  #
+  #  @param address - The address to format
+  #  @param country - The country where the address is based
+  #  @return - the data from the api
+  #
+  def getToolsFormatAddress( address, country)
+    params = Hash.new
+    params['address'] = address
+    params['country'] = country
+    return doCurl("get","/tools/format/address",params)
+  end
+
+
   #
   # With a known entity id, an invoice_address object can be updated.
   #

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Glynn Bird
@@ -16,8 +16,21 @@ cert_chain: []
 
 date: 2013-03-07 00:00:00 +00:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 7
+        - 7
+        version: 1.7.7
+  type: :runtime
+  version_requirements: *id001
 description: Allows easy integration with the Central Index API
 email: developers@centralindex.com
 executables: []