client.rb in futures_pipeline-0.1.0

- old
+ new

@@ -11,12 +11,11 @@
     # @param options [Hash] A customizable set of options.
     # @option options rpp [Integer] The results per page from the first career in the list.
     # @option options page [Integer] the page of results from the first career in the list.
     # @return [Array<Hashie::Mash>]
     # @example
-    #   @client = FuturesPipeline.new
-    #   @client.careers
+    #   FuturesPipeline.careers
     def careers(options={})
       get("/api/v1/careers.json", options)
     end
 
     # Get a single career using O\*NET code.
@@ -24,12 +23,11 @@
     # @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")
+    #   FuturesPipeline.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
 
@@ -37,13 +35,11 @@
     #
     # @param moc [String] The MOC
     # @param options [Hash] A customizable set of options.
     # @return [Hashie::Mash]
     # @example
-    #   @client = FuturesPipeline.new
-    #   @client.search("11b")
+    #   FuturesPipeline.search("11b")
     def search(moc, options={})
        get("/api/v1/careers/search.json?moc=#{moc}", options)
     end
-
   end
 end