nyt_search 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4ffb4d304aa573af6de16ba43e68692bd2dba06
-  data.tar.gz: 9e1199032697a8c3a7497041618130fb3dda1008
+  metadata.gz: b88d9e94bba85041a03bc51b5f3b0a83a670624c
+  data.tar.gz: f9deb3fa48bc351dd94136a5f70fef062ccd5869
 SHA512:
-  metadata.gz: 5903d81e4c3f82788263bdf009b58a7aebca53a6859156ec6ea2e1959c750d1b7669531073b378ed3f2189b6b27fc2d3ac1447f8b5e71ec069e8caf7fb6fbf7d
-  data.tar.gz: 44154c40bf641795cf89a27ddb5df4ebe6a2b2c85707fe50b7a4c5ea3631a6bcd190982aece97a199a88d39fbf09961fca37a037a81ac83b001bec8e48c81f91
+  metadata.gz: 59c187791fe0b7df766b538e13d1e55d061b70471ef47b7b1157595f5eae59fb7ad3675bf115fddc38a67115d341a9943697261dbc2d8d6f97c7151e5089b2fc
+  data.tar.gz: 68b84f6fee18a6420640441d9b07bfaa54596d3ed73aaf62a9b4792b004bfeda8c2a07dcd93ef8d15d14dfce0f3ba7c031212d4b38f466f2902d6199497859c6

data/README.md

@@ -29,18 +29,40 @@ If rails, set it in *config/environments/*
 ## Usage
 
 ```
-@search = NytSearch::Article.search(query: "obama", sort: "newest", page: 2)['response']['docs']
+@search = NytSearch::Article.search(query: "obama", sort: "newest", page: 2)
 ```
 
-Available options: [
-                    ```
-                    query, 
-                    sort(newest, oldest),
-                    page, 
-                    begin_date(YYYYMMDD), 
-                    end_date(YYYYMMDD)
-                    ```
-                    ]
+**Available options**:
+```
+query
+sort(newest, oldest)
+page
+begin_date(YYYYMMDD)
+end_date(YYYYMMDD)
+only("headline,web_url") #hash will have only this fields
+```
+
+**Limits the fields returned in your search results. By default (unless you include an "only" list in your request), the following fields are returned**:
+
+```
+web_url
+snippet
+lead_paragraph
+abstract
+print_page
+blog
+source
+multimedia
+headline
+keywords
+pub_date
+document_type
+news_desk
+byline
+type_of_material
+_id
+word_count
+```
 
 ## Contributing
 

data/lib/nyt_search/search.rb

@@ -6,6 +6,12 @@ module NytSearch
       url += "&sort=#{options[:sort]}" if options[:sort]
       url += "&begin_date=#{options[:begin_date]}" if options[:begin_date]
       url += "&end_date=#{options[:end_date]}" if options[:end_date]
+
+      if options[:fields]
+        fields = options[:fields].delete(' ')
+        url += "&fl=#{fields}"
+      end
+
       NytSearch::Api.get_json(url)['response']['docs']
     end
   end

data/lib/nyt_search/version.rb

@@ -1,3 +1,3 @@
 module NytSearch
-  VERSION = "0.1.1"
-end
+  VERSION = "0.1.2"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nyt_search
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Vitaliy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2015-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler