chamba_search_mx 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 314046f5b3c5a33b5eb7690cbd7c35e253b96819
-  data.tar.gz: 314bd2a0905007d1ee93c5496985d9325630ccfd
+  metadata.gz: 8339f6912ab4bd03564b235ac3e2d25a1840afd7
+  data.tar.gz: 2332f435f2a53e99af4a871d3e70a78ce940f770
 SHA512:
-  metadata.gz: f3bb0cec85ca5d9e2acf6d49acf0e294816ea5ec105e2d092eb874bc2dc746776c1e43fe52ac756ac0ea1413ae7b2ca3f497c3fc66549777ef6beed7dda69481
-  data.tar.gz: ae7b800437747bc51959b47acdbc3420cc1518d0d319e3a170f3b8a45a9e80936792d612666d3c2e42e57e093a5b95c6cfd6291032757fd6906726600407ea47
+  metadata.gz: c9c2889694025b8adebb2b92df5e53246fc0cb390e28e46fe886190e3c438a91f098b273a0d176fd4d9361e1505dba3ff40a82c387aa8c78c0758fd647a277b1
+  data.tar.gz: a03a9d067007cba52b83d2d2a8c5e1ffc3efb37fb29a430ef375f20e3f0d9958bd7ddd6f2430cfd968cce9171f67e98cab0bf1b839e617a04e6457ef082d83ef

data/CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [v0.1.1]
+- More documentation added
+
 ## [v0.1.0]
 ### Added
 - ChambaSearchMx module added by @richistron
@@ -11,4 +14,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - rspec tests added by @richistron
 
 [v0.1.0]:https://github.com/richistron/chamba_search_mx/tree/v0.1.0
+[v0.1.1]:https://github.com/richistron/chamba_search_mx/tree/v0.1.0
 

data/lib/chamba_search_mx/finder.rb

@@ -2,6 +2,8 @@ module ChambaSearchMx
   ##
   # finds jobs and returns simplified objects of them selfs
   class Finder
+    ##
+    # @attribute <Array>
     attr_reader :jobs
     def initialize(options = {})
       @formatter = options[:formatter] || ChambaSearchMx::UrlFormatter.new
@@ -10,6 +12,10 @@ module ChambaSearchMx
       @job = options[:job] || ChambaSearchMx::JobPage.new
     end
 
+    ##
+    # @param <String> search
+    # @param <Hash> options
+    # @return <Class> self
     def find(search, options = {})
       @search = search
       @options = options
@@ -18,36 +24,50 @@ module ChambaSearchMx
       self
     end
 
+    private
+
+    ##
+    # @raise <ArgumentError>
     def validate_arguments
       error_msg = 'search must be a non empty string'
       raise ArgumentError, error_msg unless search_valid?
     end
 
+    ##
+    # @return <Boolean>
     def search_valid?
-      if @search.class != String || @search.empty?
-        false
-      else
-        true
-      end
+      return false if @search.class != String
+      return false if @search.empty?
+      true
     end
 
+    ##
+    # @return <Array>
     def find_jobs
       @jobs = job_urls.map { |url| @job.load(url).data }
     end
 
+    ##
+    # @return <Array>
     def job_urls
       pagination_urls.map { |url| @search_page.load(url).job_urls }.flatten
     end
 
+    ##
+    # @return <Array>
     def pagination_urls
       @pagination.load(format_url).urls
     end
 
+    ##
+    # @returm <string>
     def format_url
       opts = search_options
       @formatter.format @search, opts
     end
 
+    ##
+    # @return <Hash>
     def search_options
       {
         location: @options[:location] || 'default',

data/lib/chamba_search_mx/version.rb

@@ -1,3 +1,3 @@
 module ChambaSearchMx
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chamba_search_mx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ricardo Rivas G.