yp 0.0.2alpha → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. data/README.md +22 -2
  2. data/lib/yp/version.rb +1 -1
  3. metadata +11 -11
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Yp
2
2
 
3
- TODO: Write a gem description
3
+ Simple Ruby wrapper to yp.com api.
4
4
 
5
5
  ## Installation
6
6
 
@@ -18,7 +18,27 @@ Or install it yourself as:
18
18
 
19
19
  ## Usage
20
20
 
21
- TODO: Write usage instructions here
21
+ Acquire an api key by registering at http://developer.yp.com
22
+
23
+ ```ruby
24
+ client = Yp::Client.new(api_key: YOUR_API_KEY)
25
+ ```
26
+
27
+ To do a search:
28
+
29
+ ```ruby
30
+ results = c.search(searchloc: ZIP_CODE, term: SEARCH_TERM, listingcount: 50, sort: 'distance')
31
+ ```
32
+ This returns an array of hashes. See http://developer.yp.com/api/Listings%2520Endpoints/Search for the attribute keys.
33
+
34
+ To do a details listing lookup, you will need this listing id, presumably found using the search api above.
35
+
36
+ ```ruby
37
+ detail = c.details(LISTING_ID_STRING)
38
+ businessName = detail['businessName']
39
+ ```
40
+
41
+ This returns a hash with attribute/value pairs. See http://http://developer.yp.com/api/Listings%2520Endpoints/Details
22
42
 
23
43
  ## Contributing
24
44
 
data/lib/yp/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Yp
2
- VERSION = "0.0.2alpha"
2
+ VERSION = "0.0.2"
3
3
  end
metadata CHANGED
@@ -1,19 +1,19 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: yp
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2alpha
5
- prerelease: 5
4
+ version: 0.0.2
5
+ prerelease:
6
6
  platform: ruby
7
7
  authors:
8
8
  - Allen Walker
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2012-03-24 00:00:00.000000000 Z
12
+ date: 2012-03-27 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: rails
16
- requirement: &22784500 !ruby/object:Gem::Requirement
16
+ requirement: &6722460 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: '3.0'
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *22784500
24
+ version_requirements: *6722460
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: faraday
27
- requirement: &22783460 !ruby/object:Gem::Requirement
27
+ requirement: &6720040 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - <
@@ -35,10 +35,10 @@ dependencies:
35
35
  version: '0.6'
36
36
  type: :runtime
37
37
  prerelease: false
38
- version_requirements: *22783460
38
+ version_requirements: *6720040
39
39
  - !ruby/object:Gem::Dependency
40
40
  name: faraday_middleware
41
- requirement: &22782180 !ruby/object:Gem::Requirement
41
+ requirement: &6699520 !ruby/object:Gem::Requirement
42
42
  none: false
43
43
  requirements:
44
44
  - - ! '>='
@@ -46,7 +46,7 @@ dependencies:
46
46
  version: '0.8'
47
47
  type: :runtime
48
48
  prerelease: false
49
- version_requirements: *22782180
49
+ version_requirements: *6699520
50
50
  description: Simple ruby wrapper for YP.com API
51
51
  email:
52
52
  - auswalk@gmail.com
@@ -77,9 +77,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
77
77
  required_rubygems_version: !ruby/object:Gem::Requirement
78
78
  none: false
79
79
  requirements:
80
- - - ! '>'
80
+ - - ! '>='
81
81
  - !ruby/object:Gem::Version
82
- version: 1.3.1
82
+ version: '0'
83
83
  requirements: []
84
84
  rubyforge_project:
85
85
  rubygems_version: 1.8.10