Contents

require 'futures_pipeline/connection'
require 'futures_pipeline/request'

module FuturesPipeline
  class Client
    include FuturesPipeline::Connection
    include FuturesPipeline::Request

    # Get a list of all the available careers. Returns an array of 50 careers per request. Use offset option to get more.
    #
    # @param options [Hash] A customizable set of options.
    # @option options offset [Integer] The offset from the first career in the list.
    # @return [Array<Hashie::Mash>]
    # @example
    #   @client = FuturesPipeline.new
    #   @client.careers
    def careers(options={})
      get("/api/v1/careers.json", options)
    end

    # Get a single career using O\*NET code.
    #
    # @param onet_soc_code [String] The O\*NET code
    # @param options [Hash] A customizable set of options.
    # @return [Hashie::Mash]
    # @raise [Faraday::Error::ResourceNotFound] If O\*NET code is not found.
    # @example
    #   @client = FuturesPipeline.new
    #   @client.career("11-1011.00")
    def career(onet_soc_code, options={})
      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

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
futures_pipeline-0.0.3	lib/futures_pipeline/client.rb