slideshare_api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dfc38449a88509d40a09ba46e053bd1b257c743
-  data.tar.gz: 3e104b627fdc62fd994d7f4fd03695b15462918a
+  metadata.gz: ee401e264b32416a6e53fa0895bcffb4971f13d5
+  data.tar.gz: d1a1b14f379f4f067d3f2460598cbfad593b6c63
 SHA512:
-  metadata.gz: ef3f6868c4ecf3b9361688f1159ec0b562637cafbfee98605b1f0801e917b0c341f75550dc8918302072b6f6dd06f9f6dbdc88765bb24de48c9eb96d0a7d070e
-  data.tar.gz: 443fe4c6cc43de6ae5c720dbea4812a939751f727d34d779756a945914edc59846266e8a1391d886f19662bdd130497fa2111fdfcc295981c1554a0b901d1367
+  metadata.gz: c1e576034d37c5948921c1146da3fe840227e87af7e26b4074dbbaa120aafdefb245a4e6f22e5a6372530e07a61bdf39e8e43435803322b8b00b1fbb14d82b43
+  data.tar.gz: 6e8280de36391a0fbb387d9601dbb7f89d9f6f273e0ff6d0dc5fbfc91d2c8026331d15b58b855e79814355600b3d95ccf40a424c2db44bd7c995048d0a4f2d12

data/README.md

@@ -1,5 +1,6 @@
 # SlideshareApi
 [![Build](https://travis-ci.org/jvenezia/slideshare_api.svg?branch=master)](https://travis-ci.org/jvenezia/slideshare_api)
+[![Gem Version](https://badge.fury.io/rb/slideshare_api.svg)](http://badge.fury.io/rb/slideshare_api)
 
 Slideshare ruby wrapper for the Slideshare API.
 
@@ -30,15 +31,16 @@ client = SlideshareApi::Client.new api_key, shared_secret
 
 Get a slideshow:
 ```ruby
+# from url...
 slideshow_url = 'http://fr.slideshare.net/awesome_slideshow'
-slideshow = client.slideshow(slideshow_url) #=> returns a SlideshareApi::Model::Slideshow
-slideshow.id
-slideshow.title
-slideshow.description
-slideshow.username
-slideshow.url
-slideshow.embed
-slideshow.language
+slideshow = client.slideshow(slideshow_url: slideshow_url) #=> returns a SlideshareApi::Model::Slideshow
+
+# from id...
+slideshow_id = '1234'
+slideshow = client.slideshow(slideshow_id: slideshow_id) #=> returns a SlideshareApi::Model::Slideshow
+
+# with optional informations...
+slideshow = client.slideshow(slideshow_id: slideshow_id, detailed: true) #=> returns a SlideshareApi::Model::Slideshow
 ```
 
 ## Contributing

data/lib/slideshare_api/client.rb

@@ -15,8 +15,12 @@ module SlideshareApi
       build_connection
     end
 
-    def slideshow(slideshow_url)
-      SlideshareApi::Model::Slideshow.new Nokogiri::XML(@connection.get('get_slideshow', api_validation_params.merge({slideshow_url: slideshow_url})).body)
+    def slideshow(options = {})
+      params = {}
+      params.merge!({slideshow_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]
+      SlideshareApi::Model::Slideshow.new Nokogiri::XML(@connection.get('get_slideshow', api_validation_params.merge(params)).body)
     end
 
     private

data/lib/slideshare_api/model/slideshow.rb

@@ -1,16 +1,70 @@
 module SlideshareApi
   module Model
     class Slideshow
-      attr_accessor :id, :title, :description, :username, :url, :embed, :language
+      attr_accessor :original_slideshow_xml,
+                    :id, :title, :stripped_title, :description, :status,
+                    :created_at, :updated_at,
+                    :username, :user_id,
+                    :url, :thumbnail_url, :thumbnail_size, :thumbnail_small_url, :embed,
+                    :language, :format, :slideshow_type,
+                    :is_downloadable, :is_in_contest,
+                    :ppt_location,
+                    :tags,
+                    :download_count, :view_count, :comment_count, :favorite_count,
+                    :slide_count,
+                    :related_slideshow_ids,
+                    :privacy_level, :is_flagged, :url_is_secret, :is_embaddable, :is_visible, :is_visible_by_contacts
 
       def initialize(slideshow_xml)
-        @id = slideshow_xml.search('ID').text
-        @title = slideshow_xml.search('Title').text
-        @description = slideshow_xml.search('Description').text
-        @username = slideshow_xml.search('Username').text
-        @url = slideshow_xml.search('URL').text
-        @embed = slideshow_xml.search('Embed').text
-        @language = slideshow_xml.search('Language').text
+        @original_slideshow_xml = slideshow_xml
+
+        @id = text_from_xml('ID')
+        @title = text_from_xml('Title')
+        @description = text_from_xml('Description')
+        @status = text_from_xml('Status')
+        @username = text_from_xml('Username')
+        @url = text_from_xml('URL')
+        @thumbnail_url = text_from_xml('ThumbnailURL')
+        @thumbnail_size = text_from_xml('ThumbnailSize')
+        @thumbnail_small_url = text_from_xml('ThumbnailSmallURL')
+        @embed = text_from_xml('Embed')
+        @created_at = Time.parse text_from_xml('Created')
+        @updated_at = Time.parse text_from_xml('Updated')
+        @language = text_from_xml('Language')
+        @format = text_from_xml('Format')
+        @is_downloadable = boolean_from_xml('Download')
+        @slideshow_type = text_from_xml('SlideshowType')
+        @is_in_contest = boolean_from_xml('InContest')
+        @user_id = text_from_xml('UserID')
+        @ppt_location = text_from_xml('PPTLocation')
+        @stripped_title = text_from_xml('StrippedTitle')
+        @tags = text_list_from_xml('Tag')
+        @download_count = text_from_xml('NumDownloads')
+        @view_count = text_from_xml('NumViews')
+        @comment_count = text_from_xml('NumComments')
+        @favorite_count = text_from_xml('NumFavorites')
+        @slide_count = text_from_xml('NumSlides')
+        @related_slideshow_ids = text_list_from_xml('RelatedSlideshowID')
+        @privacy_level = text_from_xml('PrivacyLevel')
+        @is_flagged = boolean_from_xml('FlagVisible')
+        @is_visible = boolean_from_xml('ShowOnSS')
+        @url_is_secret = boolean_from_xml('SecretURL')
+        @is_embaddable = boolean_from_xml('AllowEmbed')
+        @is_visible_by_contacts = boolean_from_xml('ShareWithContacts')
+      end
+
+      private
+
+      def boolean_from_xml(attribute_name)
+        @original_slideshow_xml.search(attribute_name).first.content == '1'
+      end
+
+      def text_from_xml(attribute_name)
+        @original_slideshow_xml.search(attribute_name).text
+      end
+
+      def text_list_from_xml(attribute_name)
+        @original_slideshow_xml.search(attribute_name).map(&:text)
       end
     end
   end

data/lib/slideshare_api/version.rb

@@ -1,3 +1,3 @@
 module SlideshareApi
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/spec/client_spec.rb

@@ -19,13 +19,27 @@ describe SlideshareApi::Client do
 
   describe '.slideshow' do
     let(:slideshow_raw_xml) { open('spec/fixtures/slideshow.xml').read }
-    let(:slideshow_url) { 'http://fr.slideshare.net/jeremyvenezia/prerequis-pour-appliquer-le-lean-startup-en-entreprise' }
 
-    before { expect(connection).to receive(:get).with('get_slideshow', api_validation_params.merge({slideshow_url: slideshow_url})).and_return(connection) }
     before { expect(connection).to receive(:body).and_return(slideshow_raw_xml) }
 
-    subject { slideshare_client.slideshow slideshow_url }
+    context 'get from slideshow url' do
+      let(:slideshow_url) { 'http://fr.slideshare.net/jeremyvenezia/prerequis-pour-appliquer-le-lean-startup-en-entreprise' }
 
-    it { should eql? SlideshareApi::Model::Slideshow.new(Nokogiri::XML(slideshow_raw_xml)) }
+      before { expect(connection).to receive(:get).with('get_slideshow', api_validation_params.merge({slideshow_url: slideshow_url})).and_return(connection) }
+
+      subject { slideshare_client.slideshow slideshow_url: slideshow_url }
+
+      it { should eql? SlideshareApi::Model::Slideshow.new(Nokogiri::XML(slideshow_raw_xml)) }
+    end
+
+    context 'get from slideshow id' do
+      let(:slideshow_id) { '1234' }
+
+      before { expect(connection).to receive(:get).with('get_slideshow', api_validation_params.merge({slideshow_id: slideshow_id})).and_return(connection) }
+
+      subject { slideshare_client.slideshow slideshow_id: slideshow_id }
+
+      it { should eql? SlideshareApi::Model::Slideshow.new(Nokogiri::XML(slideshow_raw_xml)) }
+    end
   end
 end

data/spec/fixtures/slideshow.xml

@@ -29,4 +29,39 @@
   <Download>0</Download>
   <SlideshowType>0</SlideshowType>
   <InContest>0</InContest>
+  <UserID>62691692</UserID>
+  <PPTLocation>
+    prerequispourappliquerleleanstartupdanslentreprise-140430023146-phpapp02-140501195007-phpapp01
+  </PPTLocation>
+  <StrippedTitle>prerequis-pour-appliquer-le-lean-startup-en-entreprise</StrippedTitle>
+  <Tags>
+    <Tag Count="1" Owner="1">leanstartup</Tag>
+    <Tag Count="1" Owner="1">entrepreneur</Tag>
+    <Tag Count="1" Owner="1">startup</Tag>
+    <Tag Count="1" Owner="1">entrepreneurship</Tag>
+    <Tag Count="1" Owner="1">business</Tag>
+  </Tags>
+  <NumDownloads>0</NumDownloads>
+  <NumViews>223</NumViews>
+  <NumComments>0</NumComments>
+  <NumFavorites>0</NumFavorites>
+  <NumSlides>28</NumSlides>
+  <RelatedSlideshows>
+    <RelatedSlideshowID rank="1">34115565</RelatedSlideshowID>
+    <RelatedSlideshowID rank="2">34120112</RelatedSlideshowID>
+    <RelatedSlideshowID rank="3">33133758</RelatedSlideshowID>
+    <RelatedSlideshowID rank="4">27569567</RelatedSlideshowID>
+    <RelatedSlideshowID rank="5">28375042</RelatedSlideshowID>
+    <RelatedSlideshowID rank="6">30302539</RelatedSlideshowID>
+    <RelatedSlideshowID rank="7">28193782</RelatedSlideshowID>
+    <RelatedSlideshowID rank="8">22861393</RelatedSlideshowID>
+    <RelatedSlideshowID rank="9">16138475</RelatedSlideshowID>
+    <RelatedSlideshowID rank="10">19583592</RelatedSlideshowID>
+  </RelatedSlideshows>
+  <PrivacyLevel>0</PrivacyLevel>
+  <FlagVisible>1</FlagVisible>
+  <ShowOnSS>0</ShowOnSS>
+  <SecretURL>0</SecretURL>
+  <AllowEmbed>0</AllowEmbed>
+  <ShareWithContacts>0</ShareWithContacts>
 </Slideshow>

data/spec/model/slideshow_spec.rb

@@ -6,12 +6,104 @@ describe SlideshareApi::Model::Slideshow do
 
     subject { SlideshareApi::Model::Slideshow.new slideshow_xml }
 
+    it { expect(subject.original_slideshow_xml).to eq slideshow_xml }
     it { expect(subject.id).to eq slideshow_xml.search('ID').text }
     it { expect(subject.title).to eq slideshow_xml.search('Title').text }
     it { expect(subject.description).to eq slideshow_xml.search('Description').text }
+    it { expect(subject.status).to eq slideshow_xml.search('Status').text }
     it { expect(subject.username).to eq slideshow_xml.search('Username').text }
     it { expect(subject.url).to eq slideshow_xml.search('URL').text }
+    it { expect(subject.thumbnail_url).to eq slideshow_xml.search('ThumbnailURL').text }
+    it { expect(subject.thumbnail_size).to eq slideshow_xml.search('ThumbnailSize').text }
+    it { expect(subject.thumbnail_small_url).to eq slideshow_xml.search('ThumbnailSmallURL').text }
     it { expect(subject.embed).to eq slideshow_xml.search('Embed').text }
+    it { expect(subject.created_at).to eq Time.parse slideshow_xml.search('Created').text }
+    it { expect(subject.updated_at).to eq Time.parse slideshow_xml.search('Updated').text }
     it { expect(subject.language).to eq slideshow_xml.search('Language').text }
+    it { expect(subject.format).to eq slideshow_xml.search('Format').text }
+
+    context 'it is downloadable' do
+      before { slideshow_xml.search('Download').first.content = 1 }
+      it { expect(subject.is_downloadable).to eq true }
+    end
+
+    context 'it is not downloadable' do
+      before { slideshow_xml.search('Download').first.content = 0 }
+      it { expect(subject.is_downloadable).to eq false }
+    end
+
+    it { expect(subject.slideshow_type).to eq slideshow_xml.search('SlideshowType').text }
+
+    context 'it is in contest' do
+      before { slideshow_xml.search('InContest').first.content = 1 }
+      it { expect(subject.is_in_contest).to eq true }
+    end
+
+    context 'it is not in contest' do
+      before { slideshow_xml.search('InContest').first.content = 0 }
+      it { expect(subject.is_in_contest).to eq false }
+    end
+
+    it { expect(subject.user_id).to eq slideshow_xml.search('UserID').text }
+    it { expect(subject.ppt_location).to eq slideshow_xml.search('PPTLocation').text }
+    it { expect(subject.stripped_title).to eq slideshow_xml.search('StrippedTitle').text }
+    it { expect(subject.tags).to eq slideshow_xml.search('Tag').map(&:text) }
+    it { expect(subject.download_count).to eq slideshow_xml.search('NumDownloads').text }
+    it { expect(subject.view_count).to eq slideshow_xml.search('NumViews').text }
+    it { expect(subject.comment_count).to eq slideshow_xml.search('NumComments').text }
+    it { expect(subject.favorite_count).to eq slideshow_xml.search('NumFavorites').text }
+    it { expect(subject.slide_count).to eq slideshow_xml.search('NumSlides').text }
+    it { expect(subject.related_slideshow_ids).to eq slideshow_xml.search('RelatedSlideshowID').map(&:text) }
+    it { expect(subject.privacy_level).to eq slideshow_xml.search('PrivacyLevel').text }
+
+    context 'it is flagged' do
+      before { slideshow_xml.search('FlagVisible').first.content = 1 }
+      it { expect(subject.is_flagged).to eq true }
+    end
+
+    context 'it is not flagged' do
+      before { slideshow_xml.search('FlagVisible').first.content = 0 }
+      it { expect(subject.is_flagged).to eq false }
+    end
+
+    context 'it is visible' do
+      before { slideshow_xml.search('ShowOnSS').first.content = 1 }
+      it { expect(subject.is_visible).to eq true }
+    end
+
+    context 'it is not visible' do
+      before { slideshow_xml.search('ShowOnSS').first.content = 0 }
+      it { expect(subject.is_visible).to eq false }
+    end
+
+    context 'url is secret' do
+      before { slideshow_xml.search('SecretURL').first.content = 1 }
+      it { expect(subject.url_is_secret).to eq true }
+    end
+
+    context 'url is not secret' do
+      before { slideshow_xml.search('SecretURL').first.content = 0 }
+      it { expect(subject.url_is_secret).to eq false }
+    end
+
+    context 'it is embaddable' do
+      before { slideshow_xml.search('AllowEmbed').first.content = 1 }
+      it { expect(subject.is_embaddable).to eq true }
+    end
+
+    context 'url is not embaddable' do
+      before { slideshow_xml.search('AllowEmbed').first.content = 0 }
+      it { expect(subject.is_embaddable).to eq false }
+    end
+
+    context 'it is visible by contacts' do
+      before { slideshow_xml.search('ShareWithContacts').first.content = 1 }
+      it { expect(subject.is_visible_by_contacts).to eq true }
+    end
+
+    context 'url is not visible by contacts' do
+      before { slideshow_xml.search('ShareWithContacts').first.content = 0 }
+      it { expect(subject.is_visible_by_contacts).to eq false }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slideshare_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jeremy Venezia
@@ -102,8 +102,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/inspectionProfiles/Project_Default.xml"
-- ".idea/inspectionProfiles/profiles_settings.xml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -113,6 +111,7 @@ files:
 - lib/slideshare_api/client.rb
 - lib/slideshare_api/model/slideshow.rb
 - lib/slideshare_api/version.rb
+- slideshare_api-0.0.1.gem
 - slideshare_api.gemspec
 - spec/client_spec.rb
 - spec/fixtures/slideshow.xml

data/.idea/inspectionProfiles/Project_Default.xml

@@ -1,33 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <profile version="1.0" is_locked="false">
-    <option name="myName" value="Project Default" />
-    <option name="myLocal" value="false" />
-    <inspection_tool class="RubyClassMethodNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyClassModuleNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyClassVariableNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyConstantNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyGlobalVariableNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyInstanceMethodNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyInstanceVariableNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyLocalVariableNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-    <inspection_tool class="RubyParameterNamingConvention" enabled="true" level="WARNING" enabled_by_default="true">
-      <option name="m_maxLength" value="90" />
-    </inspection_tool>
-  </profile>
-</component>

data/.idea/inspectionProfiles/profiles_settings.xml

@@ -1,7 +0,0 @@
-<component name="InspectionProjectProfileManager">
-  <settings>
-    <option name="PROJECT_PROFILE" value="Project Default" />
-    <option name="USE_PROJECT_PROFILE" value="true" />
-    <version value="1.0" />
-  </settings>
-</component>