slideshare_api 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e776ba29ac6587e0d9c29059fb8cd152b5b78ba0
-  data.tar.gz: 9b7c6b750b62c5a9ed91d24f5788dfdd67774854
+  metadata.gz: a16c3c28fdd13a8757eae15e401b942d07599654
+  data.tar.gz: 24dded61dd55b4c4e6904d65d59cfc525a61dc2d
 SHA512:
-  metadata.gz: b9f3a09abb779cd3c354422f54dcc0908a38ac4abd539afdf706ef42a604606853aa6f9b68ca7ec6373c1b67d8879af51ddf5c679df0c7db705070b052667191
-  data.tar.gz: e2fef5a4c8e05202299bb1e1f27677118b37b4c05360e924e31a21372e4a138b9b7b21c1f0ca0f286e25830e57f76938f8267439421b24e36ca308aea71acafd
+  metadata.gz: 5de9915459364d8e66cd91f010ac846fdb01d7e818089a163e4293af3d3a5dbd85107039b9b928d6009cf72b0031cae2f115b51dc15e38819f22afefa9eb1d05
+  data.tar.gz: 914887caefb636f54055fb34404e0dff6089dbea91435e8b7e3491dd6cd10162e52d6290a0576bc99b50e640d29d7622e4673c6b68364b2f7006e5fc9d53eb0e

data/README.md

@@ -30,7 +30,7 @@ shared_secret = 'your shared secret'
 client = SlideshareApi::Client.new api_key, shared_secret
 ```
 
-Get a slideshow:
+**Get a slideshow:**
 ```ruby
 # from url...
 slideshow_url = 'http://fr.slideshare.net/awesome/slideshow'
@@ -44,7 +44,7 @@ slideshow = client.slideshow(slideshow_id: slideshow_id) #=> returns a Slideshar
 slideshow = client.slideshow(slideshow_id: slideshow_id, detailed: true) #=> returns a SlideshareApi::Model::Slideshow
 ```
 
-Get slideshows:
+**Get slideshows:**
 ```ruby
 # by tag...
 tag = 'ruby'
@@ -62,11 +62,25 @@ slideshows = client.slideshows(user: user) #=> returns an array of SlideshareApi
 slideshows = client.slideshows(user: user, detailed: true) #=> returns an array of SlideshareApi::Model::Slideshow
 ```
 
-Search slideshows:
+**Search slideshows:**
 ```ruby
 query = 'elcurator'
-slideshows = client.search(query) #=> returns an array of SlideshareApi::Model::Slideshow
+options = {detailed: true, page: 2}
+slideshows = client.search(query, options) #=> returns an array of SlideshareApi::Model::Slideshow
 ```
+Optional search parameters:
+
+| Option       | Default     | Can be                                                                                                                                                                                   |
+| ------------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| detailed     | false       | true, false                                                                                                                                                                              |
+| page         | 1           |                                                                                                                                                                                          |
+| per_page     | 12          | maximum: 50                                                                                                                                                                              |
+| language     | 'en'        | '**' (All), 'es' (Spanish), 'pt' (Portuguese), 'fr' (French), 'it' (Italian), 'nl' (Dutch), 'de' (German), 'zh' (Chinese), 'ja' (Japanese), 'ko' (Korean), 'ro' (Romanian), '!!' (Other) |
+| ordered_by   | 'relevance' | 'mostviewed', 'mostdownloaded', 'lastest'                                                                                                                                                |
+| upload_date  | 'any'       | 'week', 'month', 'year'                                                                                                                                                                  |
+| downloadable | all         | true, false                                                                                                                                                                              |
+| format       | 'all'       | 'pdf' (PDF), 'ppt' (PowerPoint), 'odp' (Open Office), 'pps' (PowerPoint Slideshow), 'pot' (PowerPoint template)                                                                          |
+| type         | 'all'       | 'presentations', 'documents', 'webinars', 'videos', 'infographics'                                                                                                                       |
 
 ## Contributing
 Feel free to contribute!

data/lib/slideshare_api/client.rb

@@ -19,7 +19,7 @@ module SlideshareApi
       params = {}
       params.merge!(slideshow_url: cleaned_url(options[:slideshow_url])) if options[:slideshow_url]
       params.merge!(slideshow_id: options[:slideshow_id]) if options[:slideshow_id]
-      params.merge!(detailed: 1) if options[:detailed]
+      params.merge!(detailed: options[:detailed] ? 0 : 1) if options.has_key?(:detailed)
       SlideshareApi::Model::Slideshow.new get('get_slideshow', params)
     end
 
@@ -38,13 +38,22 @@ module SlideshareApi
         raise SlideshareApi::Error, 'Required Parameter Missing'
       end
 
-      params.merge!(detailed: 1) if options[:detailed]
+      params.merge!(detailed: options[:detailed] ? 1 : 0) if options.has_key?(:detailed)
       get(path, params).search('Slideshow').map { |s| SlideshareApi::Model::Slideshow.new(s) }
     end
 
-    def search(query)
+    def search(query, options = {})
       params = {}
       params.merge!(q: query)
+      params.merge!(detailed: options[:detailed] ? 1 : 0) if options.has_key?(:detailed)
+      params.merge!(page: options[:page]) if options[:page]
+      params.merge!(items_per_page: options[:per_page]) if options[:per_page]
+      params.merge!(lang: options[:language]) if options[:language]
+      params.merge!(sort: options[:ordered_by]) if options[:ordered_by]
+      params.merge!(upload_date: options[:upload_date]) if options[:upload_date]
+      params.merge!(download: options[:downloadable] ? 1 : 0) if options.has_key?(:downloadable)
+      params.merge!(fileformat: options[:format]) if options[:format]
+      params.merge!(file_type: options[:type]) if options[:type]
       get('search_slideshows', params).search('Slideshow').map { |s| SlideshareApi::Model::Slideshow.new(s) }
     end
 

data/lib/slideshare_api/version.rb

@@ -1,3 +1,3 @@
 module SlideshareApi
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/spec/client_spec.rb

@@ -132,12 +132,24 @@ describe SlideshareApi::Client do
       let(:query) { 'query' }
       let(:slideshows_raw_xml) { open('spec/fixtures/slideshows.xml').read }
 
-      before { expect(connection).to receive(:get).with('search_slideshows', api_validation_params.merge({q: query})).and_return(connection) }
-      before { expect(connection).to receive(:body).and_return(slideshows_raw_xml) }
+      context 'without options' do
+        before { expect(connection).to receive(:get).with('search_slideshows', api_validation_params.merge({q: query})).and_return(connection) }
+        before { expect(connection).to receive(:body).and_return(slideshows_raw_xml) }
+
+        subject { slideshare_client.search query }
+
+        it { should eq Nokogiri::XML(slideshows_raw_xml).search('Slideshow').map { |s| SlideshareApi::Model::Slideshow.new(s) } }
+      end
+
+      context 'with params' do
+        let(:params) { {q: query, detailed: 1, page: 2, items_per_page: 10, lang: 'fr', sort: 'mostviewed', upload_date: 'month', download: 0, fileformat: 'ppt', file_type: 'videos'} }
+        before { expect(connection).to receive(:get).with('search_slideshows', api_validation_params.merge(params)).and_return(connection) }
+        before { expect(connection).to receive(:body).and_return(slideshows_raw_xml) }
 
-      subject { slideshare_client.search query }
+        subject { slideshare_client.search query, detailed: true, page: 2, per_page: 10, language: 'fr', ordered_by: 'mostviewed', upload_date: 'month', downloadable: false, format: 'ppt', type: 'videos' }
 
-      it { should eq Nokogiri::XML(slideshows_raw_xml).search('Slideshow').map { |s| SlideshareApi::Model::Slideshow.new(s) } }
+        it { should eq Nokogiri::XML(slideshows_raw_xml).search('Slideshow').map { |s| SlideshareApi::Model::Slideshow.new(s) } }
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slideshare_api
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Jeremy Venezia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-01 00:00:00.000000000 Z
+date: 2014-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler