yellow_api 0.0.1 → 0.0.2

data/README.md

@@ -1,14 +1,39 @@
 # Yellow API
 
-Ruby wrapper for the YellowPages' Yellow API
+Ruby wrapper for the YellowPages' [YellowAPI](http://www.yellowapi.com).
 
 ## Installation
-    gem install yellow-api
+    gem install yellow_api
+
+## Examples
+
+    require 'yellow_api'
+    
+    # Creating a client
+    @client = YellowApi.new(:apikey => "yourapikeygoeshere")
+    
+    @client = YellowApi.new(:apikey => "sandboxapikey", :sandbox_enabled => true)
+
+    # Find businesses by listing
+    @client.find_business("barber", "Ottawa")
+
+    @client.find_business("barber", "Ottawa", { :pgLen => 10 }) # Limit to 10
+
+    # Get business details
+    my_barber = @client.find_business("barber", "Ottawa").listings.first
+    @client.get_business_details("Ontario", my_barber.name, my_barber.listingId)
+
+    # Find dealers
+    @client.find_dealer(6418182, { :pgLen => 10 })
+
+    # Get type ahead
+    @client.get_type_ahead("auto", :what)
+    @client.get_type_ahead("monct", :where)
 
 ## Documentation
-[See here](http://rdoc.info/gems/yellow-api)
+[See here](http://rdoc.info/github/ianbishop/yellow_api/master/YellowApi)
 
-## Examples
+[Official API docs](http://www.yellowapi.com/docs/places)
 
 ## Inspiration
 API style was largely stolen/inspired by [hacker_news_search](https://github.com/ryanatwork/hacker_news_search) and [twitter](https://github.com/jnunemaker/twitter).

data/lib/yellow_api/client/get_business_details.rb

@@ -1,7 +1,25 @@
+require 'active_support/all'
+
 module YellowApi
   class Client
     module GetBusinessDetails
 
+      PROVINCE_ABBREVIATION_MAP = {
+        :ab => "Alberta",
+        :bc => "British-Columbia",
+        :mb => "Manitoba",
+        :nb => "New-Brunswick",
+        :nl => "Newfoundland-and-Labrador",
+        :nt => "Northwest-Territories",
+        :ns => "Nova-Scotia",
+        :nu => "Nunavut",
+        :on => "Ontario",
+        :pe => "Prince-Edward-Island",
+        :qc => "Quebec",
+        :sk => "Saskatchewan",
+        :yt => "Yukon"
+      }
+
       # Gets business details.
       # 
       # @see http://www.yellowapi.com/docs/places/#getbusinessdetails
@@ -20,13 +38,34 @@ module YellowApi
       # @example
       #   YellowApi.get_business_details("Ile-du-Prince-Edouard", "Co-operators-The", 6418182)
       def get_business_details(province, business_name, listing_id, options={})
-        options[:prov] = province
-        options["bus-name"] = business_name
+        options[:prov] = normalize(expand_province(province))
+        options["bus-name"] = normalize(business_name)
         options[:listingId] = listing_id
+        options[:city] = normalize(options[:city]) if options.has_key? :city
 
         get('/GetBusinessDetails/', options)
       end
 
+      # Normalizes a given string
+      #
+      # All accents are removed (i.e. ‘à’ becomes ‘a’), 
+      # and All non-alphanumeric characters are replaced by dash “-”, and
+      # Multiple dashes are replaced by a single dash.
+      #
+      # @see http://www.yellowapi.com/docs/places/#getbusinessdetails
+      # @see http://stackoverflow.com/questions/225471/how-do-i-replace-accented-latin-characters-in-ruby
+      def normalize(s)
+        s.mb_chars.normalize(:kd).gsub(/[^\x00-\x7F]/n, '').to_s
+          .gsub(/[\W]/, '-').gsub(/-+/, '-')
+      end
+
+      # Expands an abbreviated province
+      #
+      # This handles the fact that FindBusiness returns abbreviated provinces codes
+      # yet expects full province names for GetBusinessDetails
+      def expand_province(prov)
+        PROVINCE_ABBREVIATION_MAP.fetch(prov.downcase.to_sym, prov)
+      end
     end
   end
 end

data/lib/yellow_api/version.rb

@@ -1,3 +1,3 @@
 module YellowApi
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/fixtures/get_type_ahead.json

@@ -0,0 +1 @@
+[{"value":"auto body shop"},{"value":"automobile wrecking & recycling"},{"value":"automobile repair"},{"value":"automobile dealers"},{"value":"automobile dealers-new cars"},{"value":"automobile dealers-used cars"},{"value":"automobile parts"},{"value":"automobile detailing"},{"value":"automobiles"},{"value":"automobile insurance"}]

data/spec/yellow_api/get_type_ahead_spec.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+describe YellowApi::Client::GetTypeAhead do
+
+  before do
+    @client = YellowApi::Client.new(:apikey => "a1s2d3f4g5h6j7k8l9k6j5j4")
+  end
+
+  describe ".get_type_ahead" do
+    before do
+      WebMock.allow_net_connect!
+
+      stub_get("GetTypeAhead/?apikey=a1s2d3f4g5h6j7k8l9k6j5j4&text=au&field=WHAT&UID=1").
+        to_return(:status => 200, :body => fixture("get_type_ahead.json"))
+    end
+
+    it "should return suggestions" do
+      wait 2 do
+        suggestions = @client.get_type_ahead("au", :what)
+
+        a_get("GetTypeAhead/?apikey=a1s2d3f4g5h6j7k8l9k6j5j4&text=au&field=WHAT&lang=en&fmt=JSON&UID=#{@client.uid}").
+        should have_been_made
+
+        suggestions.length.should > 0
+      end
+    end
+  end
+end

data/yellow_api.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'multi_json', '~> 1.0.2'
   gem.add_runtime_dependency 'rash', '~> 0.3.0'
   gem.add_runtime_dependency 'uuid', '~> 2.3.5'
+  gem.add_runtime_dependency 'activesupport', '~> 3.2.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yellow_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &77299160 !ruby/object:Gem::Requirement
+  requirement: &72188980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *77299160
+  version_requirements: *72188980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &77297970 !ruby/object:Gem::Requirement
+  requirement: &72188360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *77297970
+  version_requirements: *72188360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &77296910 !ruby/object:Gem::Requirement
+  requirement: &72187120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *77296910
+  version_requirements: *72187120
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &77296180 !ruby/object:Gem::Requirement
+  requirement: &72186590 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.5.3
   type: :development
   prerelease: false
-  version_requirements: *77296180
+  version_requirements: *72186590
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &77295100 !ruby/object:Gem::Requirement
+  requirement: &72185860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.7.6
   type: :development
   prerelease: false
-  version_requirements: *77295100
+  version_requirements: *72185860
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &77294490 !ruby/object:Gem::Requirement
+  requirement: &72185320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *77294490
+  version_requirements: *72185320
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &77328080 !ruby/object:Gem::Requirement
+  requirement: &72184950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.4
   type: :runtime
   prerelease: false
-  version_requirements: *77328080
+  version_requirements: *72184950
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &77327400 !ruby/object:Gem::Requirement
+  requirement: &72184420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *77327400
+  version_requirements: *72184420
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &77326570 !ruby/object:Gem::Requirement
+  requirement: &72252170 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *77326570
+  version_requirements: *72252170
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &77326220 !ruby/object:Gem::Requirement
+  requirement: &72251260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *77326220
+  version_requirements: *72251260
 - !ruby/object:Gem::Dependency
   name: rash
-  requirement: &77325580 !ruby/object:Gem::Requirement
+  requirement: &72250510 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *77325580
+  version_requirements: *72250510
 - !ruby/object:Gem::Dependency
   name: uuid
-  requirement: &77324320 !ruby/object:Gem::Requirement
+  requirement: &72249390 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -142,7 +142,18 @@ dependencies:
         version: 2.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *77324320
+  version_requirements: *72249390
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &72248400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *72248400
 description: Simple ruby wrapper for the YellowPages' Yellow API
 email: ian.bishop@unb.ca
 executables: []
@@ -168,11 +179,13 @@ files:
 - spec/fixtures/find_business.json
 - spec/fixtures/find_dealer.json
 - spec/fixtures/get_business_details.json
+- spec/fixtures/get_type_ahead.json
 - spec/helper.rb
 - spec/yellow_api/client_spec.rb
 - spec/yellow_api/find_business_spec.rb
 - spec/yellow_api/find_dealer_spec.rb
 - spec/yellow_api/get_business_details_spec.rb
+- spec/yellow_api/get_type_ahead_spec.rb
 - spec/yellow_api_spec.rb
 - yellow_api.gemspec
 homepage: https://github.com/ianbishop/yellow_api
@@ -203,10 +216,12 @@ test_files:
 - spec/fixtures/find_business.json
 - spec/fixtures/find_dealer.json
 - spec/fixtures/get_business_details.json
+- spec/fixtures/get_type_ahead.json
 - spec/helper.rb
 - spec/yellow_api/client_spec.rb
 - spec/yellow_api/find_business_spec.rb
 - spec/yellow_api/find_dealer_spec.rb
 - spec/yellow_api/get_business_details_spec.rb
+- spec/yellow_api/get_type_ahead_spec.rb
 - spec/yellow_api_spec.rb
 has_rdoc: