yp 0.0.2alpha → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Yp
 
-TODO: Write a gem description
+Simple Ruby wrapper to yp.com api. 
 
 ## Installation
 
@@ -18,7 +18,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Acquire an api key by registering at http://developer.yp.com
+
+```ruby
+client = Yp::Client.new(api_key: YOUR_API_KEY)
+```
+
+To do a search:
+
+```ruby 
+results = c.search(searchloc: ZIP_CODE, term: SEARCH_TERM, listingcount: 50, sort: 'distance')
+```
+This returns an array of hashes. See http://developer.yp.com/api/Listings%2520Endpoints/Search for the attribute keys.
+
+To do a details listing lookup, you will need this listing id, presumably found using the search api above.
+
+```ruby
+detail = c.details(LISTING_ID_STRING)
+businessName = detail['businessName']
+```
+
+This returns a hash with attribute/value pairs. See http://http://developer.yp.com/api/Listings%2520Endpoints/Details
 
 ## Contributing
 

data/lib/yp/version.rb

@@ -1,3 +1,3 @@
 module Yp
-  VERSION = "0.0.2alpha"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: yp
 version: !ruby/object:Gem::Version
-  version: 0.0.2alpha
-  prerelease: 5
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Allen Walker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-24 00:00:00.000000000 Z
+date: 2012-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &22784500 !ruby/object:Gem::Requirement
+  requirement: &6722460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *22784500
+  version_requirements: *6722460
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &22783460 !ruby/object:Gem::Requirement
+  requirement: &6720040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <
@@ -35,10 +35,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *22783460
+  version_requirements: *6720040
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &22782180 !ruby/object:Gem::Requirement
+  requirement: &6699520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -46,7 +46,7 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *22782180
+  version_requirements: *6699520
 description: Simple ruby wrapper for YP.com API
 email:
 - auswalk@gmail.com
@@ -77,9 +77,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10