authentic_jobs 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
data/.gitignore CHANGED
@@ -17,5 +17,6 @@ tmtags
17
17
  coverage
18
18
  rdoc
19
19
  pkg
20
+ .yardoc
20
21
 
21
22
  ## PROJECT::SPECIFIC
@@ -0,0 +1,7 @@
1
+ --readme README.markdown
2
+ --markup markdown
3
+ --markup-provider rdiscount
4
+ --default-return nil
5
+ -p ../yardoc_templates
6
+ -o ../../sites/wynn/public/projects/authentic_jobs/api
7
+ --no-private
@@ -8,23 +8,23 @@ Find your next gig from the console! This is a Ruby wrapper for the [AuthenticJo
8
8
 
9
9
  ## Usage
10
10
 
11
- ### Create a client with your API key
11
+ Create a client with your API key
12
12
 
13
13
  client = AuthenticJobs.new('OU812') # <-- Get your key at http://www.authenticjobs.com/api/
14
14
 
15
- ### Search for jobs
15
+ Search for jobs
16
16
 
17
17
  jobs = client.search(:location => 'austintxus', :keywords => 'ruby')
18
18
 
19
- ### List all companies with current listings
19
+ List all companies with current listings
20
20
 
21
21
  companies = client.companies
22
22
 
23
- ### List all job types
23
+ List all job types
24
24
 
25
25
  types = client.types
26
26
 
27
- ### List all job categories
27
+ List all job categories
28
28
 
29
29
  categories = client.categories
30
30
 
data/Rakefile CHANGED
@@ -11,12 +11,12 @@ begin
11
11
  gem.homepage = "http://github.com/pengwynn/authentic_jobs"
12
12
  gem.authors = ["Wynn Netherland"]
13
13
 
14
- gem.add_dependency('hashie', '~> 0.1.3')
15
- gem.add_dependency('httparty', '~> 0.4.5')
14
+ gem.add_dependency('hashie', '~> 0.2.0')
15
+ gem.add_dependency('httparty', '~> 0.5.2')
16
16
 
17
17
  gem.add_development_dependency('shoulda', '>= 2.10.1')
18
18
  gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
19
- gem.add_development_dependency('mocha', '0.9.4')
19
+ gem.add_development_dependency('mocha', '~> 0.9.4')
20
20
  gem.add_development_dependency('fakeweb', '>= 1.2.5')
21
21
  end
22
22
  Jeweler::GemcutterTasks.new
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.2.0
1
+ 0.2.1
@@ -5,11 +5,11 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{authentic_jobs}
8
- s.version = "0.2.0"
8
+ s.version = "0.2.1"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Wynn Netherland"]
12
- s.date = %q{2009-12-20}
12
+ s.date = %q{2010-06-12}
13
13
  s.description = %q{Ruby wrapper for the Authentic Jobs API}
14
14
  s.email = %q{wynn.netherland@gmail.com}
15
15
  s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
19
19
  s.files = [
20
20
  ".document",
21
21
  ".gitignore",
22
+ ".yardopts",
22
23
  "LICENSE",
23
24
  "README.markdown",
24
25
  "Rakefile",
@@ -39,7 +40,7 @@ Gem::Specification.new do |s|
39
40
  s.homepage = %q{http://github.com/pengwynn/authentic_jobs}
40
41
  s.rdoc_options = ["--charset=UTF-8"]
41
42
  s.require_paths = ["lib"]
42
- s.rubygems_version = %q{1.3.5}
43
+ s.rubygems_version = %q{1.3.6}
43
44
  s.summary = %q{Ruby wrapper for the Authenic Jobs API}
44
45
  s.test_files = [
45
46
  "test/helper.rb",
@@ -52,26 +53,26 @@ Gem::Specification.new do |s|
52
53
  s.specification_version = 3
53
54
 
54
55
  if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
55
- s.add_runtime_dependency(%q<hashie>, ["~> 0.1.3"])
56
- s.add_runtime_dependency(%q<httparty>, ["~> 0.4.5"])
56
+ s.add_runtime_dependency(%q<hashie>, ["~> 0.2.0"])
57
+ s.add_runtime_dependency(%q<httparty>, ["~> 0.5.2"])
57
58
  s.add_development_dependency(%q<shoulda>, [">= 2.10.1"])
58
59
  s.add_development_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
59
- s.add_development_dependency(%q<mocha>, ["= 0.9.4"])
60
+ s.add_development_dependency(%q<mocha>, ["~> 0.9.4"])
60
61
  s.add_development_dependency(%q<fakeweb>, [">= 1.2.5"])
61
62
  else
62
- s.add_dependency(%q<hashie>, ["~> 0.1.3"])
63
- s.add_dependency(%q<httparty>, ["~> 0.4.5"])
63
+ s.add_dependency(%q<hashie>, ["~> 0.2.0"])
64
+ s.add_dependency(%q<httparty>, ["~> 0.5.2"])
64
65
  s.add_dependency(%q<shoulda>, [">= 2.10.1"])
65
66
  s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
66
- s.add_dependency(%q<mocha>, ["= 0.9.4"])
67
+ s.add_dependency(%q<mocha>, ["~> 0.9.4"])
67
68
  s.add_dependency(%q<fakeweb>, [">= 1.2.5"])
68
69
  end
69
70
  else
70
- s.add_dependency(%q<hashie>, ["~> 0.1.3"])
71
- s.add_dependency(%q<httparty>, ["~> 0.4.5"])
71
+ s.add_dependency(%q<hashie>, ["~> 0.2.0"])
72
+ s.add_dependency(%q<httparty>, ["~> 0.5.2"])
72
73
  s.add_dependency(%q<shoulda>, [">= 2.10.1"])
73
74
  s.add_dependency(%q<jnunemaker-matchy>, ["= 0.4.0"])
74
- s.add_dependency(%q<mocha>, ["= 0.9.4"])
75
+ s.add_dependency(%q<mocha>, ["~> 0.9.4"])
75
76
  s.add_dependency(%q<fakeweb>, [">= 1.2.5"])
76
77
  end
77
78
  end
@@ -1,9 +1,4 @@
1
- require 'rubygems'
2
-
3
- gem 'hashie', '~> 0.1.3'
4
1
  require 'hashie'
5
-
6
- gem 'httparty', '~> 0.4.5'
7
2
  require 'httparty'
8
3
 
9
4
  directory = File.expand_path(File.dirname(__FILE__))
@@ -30,47 +25,73 @@ class AuthenticJobs
30
25
  self.api_key = api_key
31
26
  end
32
27
 
28
+ # List of companies that are currently advertising positions, explicitly refreshing cache
29
+ #
30
+ # @return [Array<Hashie::Mash>] list of companies
33
31
  def companies!
34
32
  mashup(self.class.get("/", :query => method_params('aj.jobs.getCompanies'))).companies.company
35
33
  end
36
34
 
35
+ # List of companies that are currently advertising positions
36
+ #
37
+ # @return [Array<Hashie::Mash>] list of companies
37
38
  def companies
38
39
  @companies ||= companies!
39
40
  end
40
41
 
42
+
43
+ # List locations for companies that are currently advertising positions, explicitly refreshing cache
44
+ #
45
+ # @return [Array<Hashie::Mash>] list of locations
41
46
  def locations!
42
47
  mashup(self.class.get("/", :query => method_params('aj.jobs.getLocations'))).locations.location
43
48
  end
44
49
 
50
+ # List locations for companies that are currently advertising positions
51
+ #
52
+ # @return [Array<Hashie::Mash>] list of locations
45
53
  def locations
46
54
  @locations ||= locations!
47
55
  end
48
56
 
49
-
50
- # category: The id of a job category to limit to. See aj.categories.getList
51
- # type: The id of a job type to limit to. See aj.types.getList
52
- # sort: Accepted values are: date-posted-desc (the default) and date-posted-asc
53
- # company: Free-text matching against company names. Suggested values are the ids from aj.jobs.getCompanies
54
- # location: Free-text matching against company location names. Suggested values are the ids from aj.jobs.getLocation
55
- # keywords: Keywords to look for in the title or description of the job posting. Separate multiple keywords with commas. Multiple keywords will be treated as an OR
56
- # page: The page of listings to return. Defaults to 1.
57
- # perpage: The number of listings per page. The default value is 10. The maximum value is 100.
57
+ # List current positions
58
+ #
59
+ # @option options [String] :category The id of a job category to limit to. See aj.categories.getList
60
+ # @option options [String] :type The id of a job type to limit to. See aj.types.getList
61
+ # @option options [String] :sort ('date-posted-desc') Accepted values are 'date-posted-desc' and 'date-posted-asc'
62
+ # @option options [String] :company Free-text matching against company names. Suggested values are the ids from aj.jobs.getCompanies
63
+ # @option options [String] :location Free-text matching against company location names. Suggested values are the ids from aj.jobs.getLocation
64
+ # @option options [String] :keywords Keywords to look for in the title or description of the job posting. Separate multiple keywords with commas. Multiple keywords will be treated as an OR
65
+ # @option options [Integer] :page (1) The page of listings to return. Defaults to 1.
66
+ # @option options [Integer] :perpage (1) The number of listings per page. The default value is 10. The maximum value is 100.
58
67
  def search(options={})
59
68
  mashup(self.class.get("/", :query => method_params('aj.jobs.search', options))).listings.listing
60
69
  end
61
70
 
71
+ # List supported job types, explicitly refreshing cache
72
+ #
73
+ # @return [Array<Hashie::Mash>] list of types
62
74
  def types!
63
75
  mashup(self.class.get("/", :query => method_params('aj.types.getList'))).types['type']
64
76
  end
65
77
 
78
+ # List supported job types
79
+ #
80
+ # @return [Array<Hashie::Mash>] list of types
66
81
  def types
67
82
  @types ||= types!
68
83
  end
69
84
 
85
+ # List supported job categories, explicitly refreshing cache
86
+ #
87
+ # @return [Array<Hashie::Mash>] list of categories
70
88
  def categories!
71
89
  mashup(self.class.get("/", :query => method_params('aj.categories.getList'))).categories.category
72
90
  end
73
91
 
92
+ # List supported job categories
93
+ #
94
+ # @return [Array<Hashie::Mash>] list of categories
74
95
  def categories
75
96
  @categories ||= categories!
76
97
  end
@@ -4,13 +4,14 @@ require 'rubygems'
4
4
 
5
5
  gem 'shoulda', '>= 2.10.1'
6
6
  gem 'jnunemaker-matchy', '0.4.0'
7
- gem 'mocha', '0.9.4'
7
+ gem 'mocha', '~> 0.9.4'
8
8
  gem 'fakeweb', '>= 1.2.5'
9
9
 
10
10
  require 'shoulda'
11
11
  require 'matchy'
12
12
  require 'mocha'
13
13
  require 'fakeweb'
14
+ require 'redgreen'
14
15
 
15
16
 
16
17
  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
metadata CHANGED
@@ -1,7 +1,12 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: authentic_jobs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.0
4
+ prerelease: false
5
+ segments:
6
+ - 0
7
+ - 2
8
+ - 1
9
+ version: 0.2.1
5
10
  platform: ruby
6
11
  authors:
7
12
  - Wynn Netherland
@@ -9,69 +14,93 @@ autorequire:
9
14
  bindir: bin
10
15
  cert_chain: []
11
16
 
12
- date: 2009-12-20 00:00:00 -06:00
17
+ date: 2010-06-12 00:00:00 -05:00
13
18
  default_executable:
14
19
  dependencies:
15
20
  - !ruby/object:Gem::Dependency
16
21
  name: hashie
17
- type: :runtime
18
- version_requirement:
19
- version_requirements: !ruby/object:Gem::Requirement
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
20
24
  requirements:
21
25
  - - ~>
22
26
  - !ruby/object:Gem::Version
23
- version: 0.1.3
24
- version:
27
+ segments:
28
+ - 0
29
+ - 2
30
+ - 0
31
+ version: 0.2.0
32
+ type: :runtime
33
+ version_requirements: *id001
25
34
  - !ruby/object:Gem::Dependency
26
35
  name: httparty
27
- type: :runtime
28
- version_requirement:
29
- version_requirements: !ruby/object:Gem::Requirement
36
+ prerelease: false
37
+ requirement: &id002 !ruby/object:Gem::Requirement
30
38
  requirements:
31
39
  - - ~>
32
40
  - !ruby/object:Gem::Version
33
- version: 0.4.5
34
- version:
41
+ segments:
42
+ - 0
43
+ - 5
44
+ - 2
45
+ version: 0.5.2
46
+ type: :runtime
47
+ version_requirements: *id002
35
48
  - !ruby/object:Gem::Dependency
36
49
  name: shoulda
37
- type: :development
38
- version_requirement:
39
- version_requirements: !ruby/object:Gem::Requirement
50
+ prerelease: false
51
+ requirement: &id003 !ruby/object:Gem::Requirement
40
52
  requirements:
41
53
  - - ">="
42
54
  - !ruby/object:Gem::Version
55
+ segments:
56
+ - 2
57
+ - 10
58
+ - 1
43
59
  version: 2.10.1
44
- version:
60
+ type: :development
61
+ version_requirements: *id003
45
62
  - !ruby/object:Gem::Dependency
46
63
  name: jnunemaker-matchy
47
- type: :development
48
- version_requirement:
49
- version_requirements: !ruby/object:Gem::Requirement
64
+ prerelease: false
65
+ requirement: &id004 !ruby/object:Gem::Requirement
50
66
  requirements:
51
67
  - - "="
52
68
  - !ruby/object:Gem::Version
69
+ segments:
70
+ - 0
71
+ - 4
72
+ - 0
53
73
  version: 0.4.0
54
- version:
74
+ type: :development
75
+ version_requirements: *id004
55
76
  - !ruby/object:Gem::Dependency
56
77
  name: mocha
57
- type: :development
58
- version_requirement:
59
- version_requirements: !ruby/object:Gem::Requirement
78
+ prerelease: false
79
+ requirement: &id005 !ruby/object:Gem::Requirement
60
80
  requirements:
61
- - - "="
81
+ - - ~>
62
82
  - !ruby/object:Gem::Version
83
+ segments:
84
+ - 0
85
+ - 9
86
+ - 4
63
87
  version: 0.9.4
64
- version:
88
+ type: :development
89
+ version_requirements: *id005
65
90
  - !ruby/object:Gem::Dependency
66
91
  name: fakeweb
67
- type: :development
68
- version_requirement:
69
- version_requirements: !ruby/object:Gem::Requirement
92
+ prerelease: false
93
+ requirement: &id006 !ruby/object:Gem::Requirement
70
94
  requirements:
71
95
  - - ">="
72
96
  - !ruby/object:Gem::Version
97
+ segments:
98
+ - 1
99
+ - 2
100
+ - 5
73
101
  version: 1.2.5
74
- version:
102
+ type: :development
103
+ version_requirements: *id006
75
104
  description: Ruby wrapper for the Authentic Jobs API
76
105
  email: wynn.netherland@gmail.com
77
106
  executables: []
@@ -84,6 +113,7 @@ extra_rdoc_files:
84
113
  files:
85
114
  - .document
86
115
  - .gitignore
116
+ - .yardopts
87
117
  - LICENSE
88
118
  - README.markdown
89
119
  - Rakefile
@@ -113,18 +143,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
113
143
  requirements:
114
144
  - - ">="
115
145
  - !ruby/object:Gem::Version
146
+ segments:
147
+ - 0
116
148
  version: "0"
117
- version:
118
149
  required_rubygems_version: !ruby/object:Gem::Requirement
119
150
  requirements:
120
151
  - - ">="
121
152
  - !ruby/object:Gem::Version
153
+ segments:
154
+ - 0
122
155
  version: "0"
123
- version:
124
156
  requirements: []
125
157
 
126
158
  rubyforge_project:
127
- rubygems_version: 1.3.5
159
+ rubygems_version: 1.3.6
128
160
  signing_key:
129
161
  specification_version: 3
130
162
  summary: Ruby wrapper for the Authenic Jobs API