article_json 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 416c6c5505374ac9303aa393dcfbfb361276fa45
-  data.tar.gz: 5e22d9856b75f0d16203678d2b00e9faa05831b5
+  metadata.gz: 0b9a465102850e508e0122f49d1a07dc2bb2f557
+  data.tar.gz: 1a8245e0c0c8e7d1d12cfc0fb3935ca339faf687
 SHA512:
-  metadata.gz: 015714d59724701d0fc6edda9a7257315d903055c6d5c3a7c233e4f0780e2f6cb227e2c02c0f30df5999d6d8bc75da643c59bda757858386c55f604f8166b601
-  data.tar.gz: dd5b53abece174c23c2639ae80ef53f28bd79004249c46dc4aec26e1c0de4fa9bb91512be40625394b3e7c740bd3229e2596fba0655d2837d0cca5e0636db651
+  metadata.gz: '0825cb1ba5323f0fc31472af514c1606720e4c3ce22011dd61da46309c6eb9bd3997c9faf32e6cca995c7cc9069caf17c3dd22bc105b10add4040a995d8d1675'
+  data.tar.gz: 738b909324f0a12a1a9a27efcbdb58b6e7f496790b2a5f99e153c4424253c2c79be7af14b4824ddf48b3865b1e32934755272edeee5569fba1d31df45b000e18

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.2.1 - 2017/11/08
+**Fix**: Handle non-successful OEmbed responses by rendering message
+
 ## 0.2.0 - 2017/11/03
 In this second release we **added support** to:
 - Export AMP along with required libraries for AMP rendering

data/lib/article_json/elements/embed.rb

@@ -28,11 +28,16 @@ module ArticleJSON
       end
 
       # Obtain the oembed data for this embed element
-      # @return [Hash]
+      # @return [Hash|nil]
       def oembed_data
         oembed_resolver&.oembed_data
       end
 
+      # @return [Array[ArticleJSON::Elements::Text]|nil]
+      def oembed_unavailable_message
+        oembed_resolver&.unavailable_message
+      end
+
       private
 
       # @return [ArticleJSON::Utils::OEmbedResolver::Base]

data/lib/article_json/export/common/html/elements/embed.rb

@@ -24,8 +24,17 @@ module ArticleJSON
             end
 
             def embedded_object
+              return unavailable_node unless @element.oembed_data
               Nokogiri::HTML.fragment(@element.oembed_data[:html])
             end
+
+            def unavailable_node
+              create_element(:span, class: 'unavailable-embed') do |span|
+                @element.oembed_unavailable_message.each do |element|
+                  span.add_child(base_class.build(element).export)
+                end
+              end
+            end
           end
         end
       end

data/lib/article_json/utils/o_embed_resolver/base.rb

@@ -7,22 +7,53 @@ module ArticleJSON
           @element = embed_element
         end
 
-        # @return [Hash]
+        # Requests the OEmbed endpoint of the respective service and returns its
+        # data as a Hash. If the endpoint returns an error, `nil` will be
+        # returned.
+        # @return [Hash|nil]
         def oembed_data
           resolver = self.class == Base ? self.class.build(@element) : self
           resolver.parsed_api_response
         end
 
+        # In case that there was an error with requesting the OEmbed data from
+        # the endpoint (e.g. because the URL is unavailable), this message can
+        # be rendered to let the user know about the issue
+        # @return [Array[ArticleJSON::Elements::Text]|nil]
+        def unavailable_message
+          [
+            ArticleJSON::Elements::Text.new(content: "The #{name} "),
+            ArticleJSON::Elements::Text.new(content: source_url,
+                                            href: source_url),
+            ArticleJSON::Elements::Text.new(content: ' is not available.'),
+          ]
+        end
+
+        def name
+          raise NotImplementedError,
+                '`#name` needs to be implemented by the subclass'
+        end
+
+        def source_url
+          raise NotImplementedError,
+                '`#source_url` needs to be implemented by the subclass'
+        end
+
         protected
 
-        # @return [Hash]
+        # @return [Hash|nil]
         def parsed_api_response
-          @api_response ||= begin
+          return @api_response if defined? @api_response
+          @api_response = begin
             uri = URI.parse(oembed_url)
             http = Net::HTTP.new(uri.host, uri.port)
             http.use_ssl = (uri.scheme == 'https')
             response = http.request(Net::HTTP::Get.new(uri, http_headers))
-            JSON.parse(response.body, symbolize_names: true)
+            if response.kind_of? Net::HTTPSuccess
+              JSON.parse(response.body, symbolize_names: true)
+            end
+          rescue Net::ProtocolError, JSON::ParserError
+            nil
           end
         end
 

data/lib/article_json/utils/o_embed_resolver/facebook_video.rb

@@ -2,17 +2,21 @@ module ArticleJSON
   module Utils
     module OEmbedResolver
       class FacebookVideo < Base
+        # Human readable name of the resolver
+        # @return [String]
+        def name
+          'Facebook video'
+        end
+
         # The URL for the oembed API call
         # @return [String]
         def oembed_url
-          "https://www.facebook.com/plugins/video/oembed.json?url=#{video_url}"
+          "https://www.facebook.com/plugins/video/oembed.json?url=#{source_url}"
         end
 
-        private
-
         # The video URL of the element
         # @return [String]
-        def video_url
+        def source_url
           "https://www.facebook.com/facebook/videos/#{@element.embed_id}"
         end
       end

data/lib/article_json/utils/o_embed_resolver/slideshare.rb

@@ -2,17 +2,22 @@ module ArticleJSON
   module Utils
     module OEmbedResolver
       class Slideshare < Base
+        # Human readable name of the resolver
+        # @return [String]
+        def name
+          'Slideshare deck'
+        end
+
         # The URL for the oembed API call
         # @return [String]
         def oembed_url
-          "https://www.slideshare.net/api/oembed/2?format=json&url=#{slide_url}"
+          'https://www.slideshare.net/api/oembed/2?format=json&url='\
+          "#{source_url}"
         end
 
-        private
-
         # The URL of the slideshow
         # @return [String]
-        def slide_url
+        def source_url
           handle, slug = @element.embed_id.split('/', 2)
           "https://www.slideshare.net/#{handle}/#{slug}"
         end

data/lib/article_json/utils/o_embed_resolver/tweet.rb

@@ -2,18 +2,22 @@ module ArticleJSON
   module Utils
     module OEmbedResolver
       class Tweet < Base
+        # Human readable name of the resolver
+        # @return [String]
+        def name
+          'Tweet'
+        end
+
         # The URL for the oembed API call
         # @return [String]
         def oembed_url
           'https://api.twitter.com/1/statuses/oembed.json?align=center' \
-            "&url=#{tweet_url}"
+            "&url=#{source_url}"
         end
 
-        private
-
         # The URL of the tweet
         # @return [String]
-        def tweet_url
+        def source_url
           handle, tweet_id = @element.embed_id.split('/', 2)
           "https://twitter.com/#{handle}/status/#{tweet_id}"
         end

data/lib/article_json/utils/o_embed_resolver/vimeo_video.rb

@@ -2,17 +2,21 @@ module ArticleJSON
   module Utils
     module OEmbedResolver
       class VimeoVideo < Base
+        # Human readable name of the resolver
+        # @return [String]
+        def name
+          'Vimeo video'
+        end
+
         # The URL for the oembed API call
         # @return [String]
         def oembed_url
-          "https://vimeo.com/api/oembed.json?url=#{video_url}"
+          "https://vimeo.com/api/oembed.json?url=#{source_url}"
         end
 
-        private
-
         # The video URL of the element
         # @return [String]
-        def video_url
+        def source_url
           "https://vimeo.com/#{@element.embed_id}"
         end
       end

data/lib/article_json/utils/o_embed_resolver/youtube_video.rb

@@ -2,17 +2,21 @@ module ArticleJSON
   module Utils
     module OEmbedResolver
       class YoutubeVideo < Base
+        # Human readable name of the resolver
+        # @return [String]
+        def name
+          'Youtube video'
+        end
+
         # The URL for the oembed API call
         # @return [String]
         def oembed_url
-          "http://www.youtube.com/oembed?format=json&url=#{video_url}"
+          "http://www.youtube.com/oembed?format=json&url=#{source_url}"
         end
 
-        private
-
         # The video URL of the element
         # @return [String]
-        def video_url
+        def source_url
           "https://www.youtube.com/watch?v=#{@element.embed_id}"
         end
       end

data/lib/article_json/version.rb

@@ -1,3 +1,3 @@
 module ArticleJSON
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: article_json
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Sager
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri