futures_pipeline 0.0.2 → 0.0.3

data/.travis.yml

@@ -3,5 +3,6 @@ rvm:
   - 1.9.1
   - 1.9.2
   - jruby
+  - rbx
   - ree
   - ruby-head

data/Gemfile

@@ -4,9 +4,5 @@ platforms :jruby do
   gem 'jruby-openssl', '~> 0.7'
 end
 
-group :development do
-  gem 'yard', :git => 'https://github.com/lsegal/yard.git'
-end
-
 # Specify your gem's dependencies in gem_template.gemspec
 gemspec

data/README.md

@@ -64,6 +64,10 @@ Submitting a Pull Request
 8. Commit and push your changes.
 9. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
 
+Credits
+-------
+Futures, Inc. REST API developed by [Tom Harris](https://github.com/tomharris).
+
 Copyright
 ---------
 Copyright (c) 2011 Code for America.

data/Rakefile

@@ -1,3 +1,5 @@
+#!/usr/bin/env rake
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 

data/futures_pipeline.gemspec

@@ -2,18 +2,19 @@
 require File.expand_path('../lib/futures_pipeline/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_development_dependency('ZenTest', '~> 4.5')
-  gem.add_development_dependency('maruku', '~> 0.6')
-  gem.add_development_dependency('rake', '~> 0.8')
-  gem.add_development_dependency('rspec', '~> 2.6')
-  gem.add_development_dependency('simplecov', '~> 0.4')
-  # gem.add_development_dependency('yard', '~> 0.7')
-  gem.add_runtime_dependency('faraday', '~> 0.6.1')
-  gem.add_runtime_dependency('faraday_middleware', '~> 0.6.3')
-  gem.add_runtime_dependency('hashie', '~> 1.0.0')
-  gem.add_runtime_dependency('json', '~> 1.5.1')
-  gem.add_runtime_dependency('multi_json', '~> 1.0.1')
-  gem.add_runtime_dependency('rash', '~> 0.3.0')
+  gem.add_development_dependency 'ZenTest', '~> 4.5'
+  gem.add_development_dependency 'maruku', '~> 0.6'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.4'
+  gem.add_development_dependency 'webmock', '~> 1.6'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_runtime_dependency 'faraday', '~> 0.6.1'
+  gem.add_runtime_dependency 'faraday_middleware', '~> 0.6.3'
+  gem.add_runtime_dependency 'hashie', '~> 1.0.0'
+  gem.add_runtime_dependency 'json', '~> 1.5.1'
+  gem.add_runtime_dependency 'multi_json', '~> 1.0.2'
+  gem.add_runtime_dependency 'rash', '~> 0.3.0'
   gem.authors = ["Erik Michaels-Ober", "Ryan Resella"]
   gem.description = %q{Ruby wrapper for the Futures, Inc. US Military Pipeline API}
   gem.email = ['erik@codeforamerica.org', 'ryan@codeforamerica.org']

data/lib/futures_pipeline/client.rb

@@ -31,5 +31,18 @@ module FuturesPipeline
       api_safe_onet_soc_code = onet_soc_code.tr(".", "-")
       get("/api/v1/careers/#{api_safe_onet_soc_code}.json", options)
     end
+
+    # Search for careers by MOC code.  Returns a list of careers related to the MOC.
+    #
+    # @param moc [String] The MOC
+    # @param options [Hash] A customizable set of options.
+    # @return [Hashie::Mash]
+    # @example
+    #   @client = FuturesPipeline.new
+    #   @client.search("11b")
+    def search(moc, options={})
+       get("/api/v1/careers/search.json?moc=#{moc}", options)
+    end
+
   end
 end

data/lib/futures_pipeline/version.rb

@@ -1,3 +1,3 @@
 module FuturesPipeline
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/faraday/response_spec.rb

@@ -18,10 +18,15 @@ describe Faraday::Response do
   }.each do |status, exception|
     context "when HTTP status is #{status}" do
 
+      before do
+        stub_get("api/v1/careers/11-1011-01.json").
+          to_return(:status => status, :body => fixture("career.json"))
+      end
+
       it "should raise #{exception.name} error" do
         lambda do
           @client.career("11-1011.01")
-        end.should raise_error(exception)
+        end.should raise_error exception
       end
     end
   end

data/spec/fixtures/search.json

@@ -0,0 +1 @@
+[{"onet_soc_code":"13-1073.00","api_safe_onet_soc_code":"13-1073-00","title":"Training and Development Specialists","link":"http://militarydemo.pipelinenc.com/careers/89-training-and-development-specialists","average_national_salary":47830},{"onet_soc_code":"33-9032.00","api_safe_onet_soc_code":"33-9032-00","title":"Security Guards","link":"http://militarydemo.pipelinenc.com/careers/586-security-guards","average_national_salary":21530}]

data/spec/futures_pipeline/client_spec.rb

@@ -6,25 +6,68 @@ describe FuturesPipeline::Client do
   end
 
   describe "#careers" do
+    before do
+      stub_get("api/v1/careers.json").
+        to_return(:status => 200, :body => fixture("careers.json"))
+    end
+
     it "should fetch all careers" do
       careers = @client.careers
       careers.first.title.should == "Chief Executives"
     end
   end
-  
-  describe "#career" do 
+
+  describe "#career" do
     context "with API-safe O*NET code" do
+      before do
+        stub_get("api/v1/careers/11-1011-00.json").
+          to_return(:status => 200, :body => fixture("career.json"))
+      end
+
       it "should fetch one career" do
         career = @client.career("11-1011-00")
         career.title.should == "Chief Executives"
       end
     end
+
     context "with O*NET status code" do
+      before do
+        stub_get("api/v1/careers/11-1011-00.json").
+          to_return(:status => 200, :body => fixture("career.json"))
+      end
+
       it "should fetch one career" do
-         career = @client.career("11-1011.00")
-          career.title.should == "Chief Executives"
+        career = @client.career("11-1011.00")
+        career.title.should == "Chief Executives"
       end
     end
   end
-  
+
+  describe "#search" do
+    context "with no paramaters" do
+      before do
+        stub_get("api/v1/careers/search.json").
+          to_return(:status => 200, :body => fixture("search.json"))
+      end
+
+      it "should return a search of careers" do
+        lambda do
+          @client.search
+        end.should raise_error ArgumentError
+      end
+    end
+
+    context "with MOC parameter" do
+      before do
+        stub_get("api/v1/careers/search.json?moc=11b").
+          to_return(:status => 200, :body => fixture("search.json"))
+      end
+
+      it "should return one career related to the MOC" do
+        search = @client.search("11b")
+        search.first.title.should == "Training and Development Specialists"
+      end
+    end
+  end
+
 end

data/spec/helper.rb

@@ -1,4 +1,45 @@
 require 'simplecov'
 SimpleCov.start
 require 'rspec'
+require 'webmock/rspec'
 require 'futures_pipeline'
+
+def a_delete(path)
+  a_request(:delete, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def a_get(path)
+  a_request(:get, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def a_post(path)
+  a_request(:post, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def a_put(path)
+  a_request(:put, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def stub_delete(path)
+  stub_request(:delete, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def stub_get(path)
+  stub_request(:get, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def stub_post(path)
+  stub_request(:post, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def stub_put(path)
+  stub_request(:put, 'http://militarydemo.pipelinenc.com/' + path)
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: futures_pipeline
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Erik Michaels-Ober
@@ -16,7 +11,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-13 00:00:00 Z
+date: 2011-05-23 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ZenTest
@@ -26,10 +22,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 17
-        segments: 
-        - 4
-        - 5
         version: "4.5"
   type: :development
   version_requirements: *id001
@@ -41,10 +33,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 0
-        - 6
         version: "0.6"
   type: :development
   version_requirements: *id002
@@ -56,11 +44,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 0
-        - 8
-        version: "0.8"
+        version: "0.9"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -71,10 +55,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 2
-        - 6
         version: "2.6"
   type: :development
   version_requirements: *id004
@@ -86,109 +66,97 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
         version: "0.4"
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: faraday
+  name: webmock
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 0
-        - 6
-        - 1
+        version: "1.6"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.7"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
         version: 0.6.1
   type: :runtime
-  version_requirements: *id006
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: faraday_middleware
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 6
-        - 3
         version: 0.6.3
   type: :runtime
-  version_requirements: *id007
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: hashie
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: json
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
         version: 1.5.1
   type: :runtime
-  version_requirements: *id009
+  version_requirements: *id011
 - !ruby/object:Gem::Dependency 
   name: multi_json
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 0
-        - 1
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
-  version_requirements: *id010
+  version_requirements: *id012
 - !ruby/object:Gem::Dependency 
   name: rash
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id013 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 3
-        - 0
         version: 0.3.0
   type: :runtime
-  version_requirements: *id011
+  version_requirements: *id013
 description: Ruby wrapper for the Futures, Inc. US Military Pipeline API
 email: 
 - erik@codeforamerica.org
@@ -219,9 +187,11 @@ files:
 - spec/fixtures/career.json
 - spec/fixtures/careers.json
 - spec/fixtures/not_found.json
+- spec/fixtures/search.json
 - spec/futures_pipeline/client_spec.rb
 - spec/futures_pipeline_spec.rb
 - spec/helper.rb
+has_rdoc: true
 homepage: https://github.com/codeforamerica/futures_pipeline
 licenses: []
 
@@ -235,23 +205,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Futures, Inc. US Military Pipeline API
@@ -260,6 +224,7 @@ test_files:
 - spec/fixtures/career.json
 - spec/fixtures/careers.json
 - spec/fixtures/not_found.json
+- spec/fixtures/search.json
 - spec/futures_pipeline/client_spec.rb
 - spec/futures_pipeline_spec.rb
 - spec/helper.rb