article_json 0.3.8 → 0.4.1

data/lib/article_json/article.rb

@@ -14,7 +14,7 @@ module ArticleJSON
     def elements
       @elements ||= begin
         if @additional_elements.any?
-          ArticleJSON::Utils::AdditionalElementPlacer
+          @additional_element_placer_class
             .new(@article_elements, @additional_elements)
             .merge_elements
         else
@@ -62,16 +62,16 @@ module ArticleJSON
       amp_exporter.html
     end
 
-    # Exporter instance for FacebookInstantArticle
-    # @return [ArticleJSON::Export::FacebookInstantArticle::Exporter]
-    def facebook_instant_article_exporter
-      ArticleJSON::Export::FacebookInstantArticle::Exporter.new(elements)
+    # Exporter instance for AppleNews
+    # @return [ArticleJSON::Export::AppleNews::Exporter]
+    def apple_news_exporter
+      ArticleJSON::Export::AppleNews::Exporter.new(elements)
     end
 
-    # FacebookInstantArticle export of the article
+    # AppleNews export of the article
     # @return [String]
-    def to_facebook_instant_article
-      facebook_instant_article_exporter.html
+    def to_apple_news
+      apple_news_exporter.to_json
     end
 
     # Exporter instance for plain text
@@ -91,10 +91,18 @@ module ArticleJSON
     # article. If the method is called multiple times, the order of additional
     # elements is maintained.
     # @param [Object] additional_elements
-    def place_additional_elements(additional_elements)
+    # @param [Class<#merge_elements>] with - The passes class's `#initialize` method needs
+    #                                        to accept two lists of elements. See
+    #                                        `ArticleJSON::Utils::AdditionalElementPlacer`
+    #                                        for reference.
+    def place_additional_elements(
+      additional_elements,
+      with: ArticleJSON::Utils::AdditionalElementPlacer
+    )
       # Reset the `#elements` method memoization
       @elements = nil
       @additional_elements.concat(additional_elements)
+      @additional_element_placer_class = with
     end
 
     class << self

data/lib/article_json/configuration.rb

@@ -14,10 +14,11 @@ module ArticleJSON
   end
 
   class Configuration
-    attr_accessor :oembed_user_agent
+    attr_accessor :oembed_user_agent, :facebook_token
 
     def initialize
       @oembed_user_agent = nil
+      @facebook_token = nil
       @custom_element_exporters = {}
     end
 
@@ -30,7 +31,7 @@ module ArticleJSON
     # @param [Symbol] exporter
     # @param [Hash[Symbol => Class]] type_class_mapping
     def register_element_exporters(exporter, type_class_mapping)
-      valid_exporters = %i(html amp facebook_instant_article plain_text)
+      valid_exporters = %i(html amp apple_news plain_text)
       unless valid_exporters.include?(exporter)
         raise ArgumentError, '`exporter` needs to be one of ' \
                              "#{valid_exporters} but is `#{exporter.inspect}`"
@@ -38,8 +39,9 @@ module ArticleJSON
       if !type_class_mapping.is_a?(Hash) ||
           type_class_mapping.keys.any? { |key| !key.is_a? Symbol } ||
           type_class_mapping.values.any? { |value| !value.is_a? Class }
-        raise ArgumentError, '`type_class_mapping` has to be a Hash with '\
-                             'symbolized keys and classes as values but is '\
+
+        raise ArgumentError, '`type_class_mapping` has to be a Hash with ' \
+                             'symbolized keys and classes as values but is ' \
                              "`#{type_class_mapping.inspect}`"
       end
 
@@ -56,4 +58,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/base.rb

@@ -37,4 +37,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/heading.rb

@@ -34,4 +34,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/image.rb

@@ -46,4 +46,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/list.rb

@@ -34,4 +34,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/paragraph.rb

@@ -36,6 +36,7 @@ module ArticleJSON
       # @return [Integer]
       def length
         return 0 if empty?
+
         @content.reduce(0) do |sum, element|
           sum + (element.respond_to?(:length) ? element.length : 0)
         end
@@ -52,4 +53,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/quote.rb

@@ -38,4 +38,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/text.rb

@@ -44,6 +44,7 @@ module ArticleJSON
       # @return [Integer]
       def length
         return 0 if blank?
+
         content.length
       end
       alias size length
@@ -63,4 +64,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/elements/text_box.rb

@@ -38,4 +38,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/export/amp/custom_element_library_resolver.rb

@@ -54,4 +54,3 @@ module ArticleJSON
     end
   end
 end
-

data/lib/article_json/export/amp/elements/embed.rb

@@ -42,18 +42,22 @@ module ArticleJSON
 
           # @return [Nokogiri::XML::Element]
           def youtube_node
-            create_element('amp-youtube',
-                           'data-videoid' => @element.embed_id,
-                           width: default_width,
-                           height: default_height)
+            create_element(
+              'amp-youtube',
+              'data-videoid' => @element.embed_id,
+              width: default_width,
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
           def vimeo_node
-            create_element('amp-vimeo',
-                           'data-videoid' => @element.embed_id,
-                           width: default_width,
-                           height: default_height)
+            create_element(
+              'amp-vimeo',
+              'data-videoid' => @element.embed_id,
+              width: default_width,
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
@@ -61,42 +65,50 @@ module ArticleJSON
             # The embed_id of a tweet is stored as "<handle>/<tweet_id>" but
             # the `amp-twitter` tag only takes the `tweet_id` part
             tweet_id = @element.embed_id.split('/').last
-            create_element('amp-twitter',
-                           'data-tweetid': tweet_id,
-                           width: default_width,
-                           height: default_height)
+            create_element(
+              'amp-twitter',
+              'data-tweetid': tweet_id,
+              width: default_width,
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
           def facebook_node
-            url = "#{@element.oembed_data[:author_url]}videos/#{@element.embed_id}"
-            create_element('amp-facebook',
-                           'data-embedded-as' => 'video',
-                           'data-href' => url,
-                           width: default_width,
-                           height: default_height)
+            url = "#{@element.oembed_data[:author_url]}/videos/#{@element.embed_id}"
+            create_element(
+              'amp-facebook',
+              'data-embedded-as' => 'video',
+              'data-href' => url,
+              width: default_width,
+              height: default_height
+            )
           end
 
           def soundcloud_node
             src = Nokogiri::HTML(@element.oembed_data[:html])
-              .xpath('//iframe/@src').first.value
-            track_id = src.match(/tracks%2F(\d+)/)[1]
-            create_element('amp-soundcloud',
-                           layout: 'fixed-height',
-                           'data-trackid': track_id,
-                           'data-visual': true,
-                           width: 'auto',
-                           height: default_height)
+                          .xpath('//iframe/@src').first.value
+            track_id = src.match(%r{tracks%2F(\d+)})[1]
+            create_element(
+              'amp-soundcloud',
+              layout: 'fixed-height',
+              'data-trackid': track_id,
+              'data-visual': true,
+              width: 'auto',
+              height: default_height
+            )
           end
 
           # @return [Nokogiri::XML::Element]
           def iframe_node
             node = Nokogiri::HTML(@element.oembed_data[:html]).xpath('//iframe')
-            create_element('amp-iframe',
-                           src: node.attribute('src').value,
-                           width: node.attribute('width').value,
-                           height: node.attribute('height').value,
-                           frameborder: '0',)
+            create_element(
+              'amp-iframe',
+              src: node.attribute('src').value,
+              width: node.attribute('width').value,
+              height: node.attribute('height').value,
+              frameborder: '0'
+            )
           end
 
           # @return [String]

data/lib/article_json/export/amp/elements/image.rb

@@ -9,11 +9,13 @@ module ArticleJSON
 
           # @return [Nokogiri::HTML::NodeSet]
           def image_node
-            create_element('amp-img',
-                           src: @element.source_url,
-                           width: default_width,
-                           height: default_height,
-                           layout: :responsive)
+            create_element(
+              'amp-img',
+              src: @element.source_url,
+              width: default_width,
+              height: default_height,
+              layout: :responsive
+            )
           end
 
           def default_width

data/lib/article_json/export/amp/exporter.rb

@@ -8,10 +8,11 @@ module ArticleJSON
         # @return [Array[Symbol]]
         def custom_element_tags
           return @custom_element_tags if defined? @custom_element_tags
+
           @custom_element_tags =
             element_exporters
-              .flat_map { |element| element.custom_element_tags }
-              .uniq
+            .flat_map { |element| element.custom_element_tags }
+            .uniq
         end
 
         # Return an array with all the javascript libraries needed for some
@@ -19,6 +20,7 @@ module ArticleJSON
         # @return [Array<String>]
         def amp_libraries
           return @amp_libraries if defined? @amp_libraries
+
           @amp_libraries =
             CustomElementLibraryResolver.new(custom_element_tags).script_tags
         end

data/lib/article_json/export/apple_news/elements/base.rb

@@ -0,0 +1,53 @@
+module ArticleJSON
+  module Export
+    module AppleNews
+      module Elements
+        class Base
+          include ArticleJSON::Export::Common::Elements::Base
+
+          # Export the given element. Dynamically looks up the right
+          # export-element-class, instantiates it and then calls the `#export`
+          # method.
+          # Defaults to nil, e.g. if no exporter is specified for the given
+          # type.
+          # @return [String]
+          def export
+            super || nil
+          end
+
+          class << self
+            # Return the module namespace this class and its subclasses are
+            # nested within.
+            # @return [Module]
+            def namespace
+              ArticleJSON::Export::AppleNews::Elements
+            end
+
+            private
+
+            # The format this exporter is returning. This is used to determine
+            # which custom element exporters should be applied from the
+            # configuration.
+            # @return [Symbol]
+            def export_format
+              :apple_news
+            end
+
+            def default_exporter_mapping
+              {
+                text: namespace::Text,
+                paragraph: namespace::Paragraph,
+                heading: namespace::Heading,
+                quote: namespace::Quote,
+                list: namespace::List,
+                image: namespace::Image,
+                embed: namespace::Embed,
+                text_box: namespace::TextBox,
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/apple_news/elements/embed.rb

@@ -0,0 +1,130 @@
+module ArticleJSON
+  module Export
+    module AppleNews
+      module Elements
+        class Embed < Base
+          # Embed| Embed, Caption
+          # @return [Hash, Array<Hash>]
+          def export
+            caption_text.nil? ? embed : [embed, caption]
+          end
+
+          private
+
+          # Embed
+          # @return [Hash]
+          def embed
+            {
+              role: role,
+              URL: source_url,
+              caption: caption_text,
+            }.compact
+          end
+
+          # Caption
+          # @return [Hash]
+          def caption
+            {
+              role: 'caption',
+              text: caption_text,
+              format: 'html',
+              layout: 'captionLayout',
+              textStyle: 'captionStyle',
+            }
+          end
+
+          # Get the exporter class for text elements
+          # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+          def text_exporter
+            self.class.exporter_by_type(:text)
+          end
+
+          # Caption Text
+          # @return [String]
+          def caption_text
+            return nil if role.nil? # Do not show captions for unsupported components
+
+            text.empty? ? nil : text
+          end
+
+          # @return [String]
+          def text
+            @element.caption.map do |child_element|
+              text_exporter.new(child_element)
+                           .export
+            end.join
+          end
+
+          def role
+            @role ||=
+              case embed_type
+              when :youtube_video, :vimeo_video, :dailymotion_video
+                :embedwebvideo
+              when :facebook_video
+                :facebook_post
+              when :tweet
+                :tweet
+              when :slideshare
+                nil
+              when :soundcloud
+                nil
+              else
+                nil
+              end
+          end
+
+          def source_url
+            case embed_type
+            when :youtube_video
+              build_embeded_youtube_url
+            when :vimeo_video
+              build_embeded_vimeo_url
+            when :dailymotion_video
+              build_embeded_vimeo_url
+            when :facebook_video
+              build_facebook_video_url
+            when :tweet
+              build_twitter_url
+            when :slideshare
+              nil
+            when :soundcloud
+              nil
+            else
+              nil
+            end
+          end
+
+          def build_embeded_youtube_url
+            "https://www.youtube.com/embed/#{embed_id}"
+          end
+
+          def build_embeded_vimeo_url
+            "https://player.vimeo.com/video/#{embed_id}"
+          end
+
+          def build_embeded_dailymotion_url
+            "https://geo.dailymotion.com/player.html?video=#{embed_id}"
+          end
+
+          def build_facebook_video_url
+            username, id = embed_id.to_s.split("/", 2)
+            "https://www.facebook.com/#{username}/videos/#{id}"
+          end
+
+          def build_twitter_url
+            username, id = embed_id.to_s.split("/", 2)
+            "https://twitter.com/#{username}/status/#{id}"
+          end
+
+          def embed_type
+            @embed_type ||= @element.embed_type.to_sym
+          end
+
+          def embed_id
+            @embed_id ||= @element.embed_id.to_sym
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/apple_news/elements/heading.rb

@@ -0,0 +1,32 @@
+module ArticleJSON
+  module Export
+    module AppleNews
+      module Elements
+        class Heading < Base
+          # Headline
+          # @return [Hash]
+          def export
+            {
+              role: role,
+              text: @element.content,
+              layout: 'titleLayout',
+              textStyle: 'defaultTitle',
+            }
+          end
+
+          private
+
+          # The role of text component for adding a heading. (Required) Always
+          # one of these roles for this component: heading, heading1, heading2,
+          # heading3, heading4, heading5, or heading6.
+          # @return [String]
+          def role
+            return 'heading' if @element.level.nil?
+
+            "heading#{@element.level}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/apple_news/elements/image.rb

@@ -0,0 +1,59 @@
+module ArticleJSON
+  module Export
+    module AppleNews
+      module Elements
+        class Image < Base
+          # Image | Image, Caption
+          # @return [Hash, Array<Hash>]
+          def export
+            caption_text.nil? ? image : [image, caption]
+          end
+
+          private
+
+          # Image
+          # @return [Hash]
+          def image
+            {
+              role: 'image',
+              URL: @element.source_url,
+              caption: caption_text,
+            }.compact
+          end
+
+          # Caption
+          # @return [Hash]
+          def caption
+            {
+              role: 'caption',
+              text: caption_text,
+              format: 'html',
+              layout: 'captionLayout',
+              textStyle: 'captionStyle',
+            }
+          end
+
+          # Get the exporter class for text elements
+          # @return [ArticleJSON::Export::Common::HTML::Elements::Base]
+          def text_exporter
+            self.class.exporter_by_type(:text)
+          end
+
+          # Caption Text
+          # @return [String]
+          def caption_text
+            text.empty? ? nil : text
+          end
+
+          # @return [String]
+          def text
+            @element.caption.map do |child_element|
+              text_exporter.new(child_element)
+                           .export
+            end.join
+          end
+        end
+      end
+    end
+  end
+end

data/lib/article_json/export/apple_news/elements/list.rb

@@ -0,0 +1,67 @@
+module ArticleJSON
+  module Export
+    module AppleNews
+      module Elements
+        class List < Base
+          # List
+          # @return [Hash]
+          def export
+            {
+              role: 'body',
+              text: list_text,
+              format: 'html',
+              layout: 'bodyLayout',
+              textStyle: 'bodyStyle',
+            }
+          end
+
+          private
+
+          # Get the exporter class for text elements
+          #
+          # @return [ArticleJSON::Export::Common::HTML::Elements::<Class>]
+          def text_exporter
+            self.class.exporter_by_type(:text)
+          end
+
+          # When it is an unordered list wrap it in <ul></ul>
+          # When it is an ordered list wrap it in <ol></ol>
+          #
+          # List Text
+          # @return [String]
+          def list_text
+            prepend_list_tag + list + append_list_tag
+          end
+
+          # Each list item should be wrapped in <li></li>
+          #
+          # @return [String]
+          def list
+            @element.content.map do |paragraph_element|
+              line_item = paragraph_element.content.map do |text_element|
+                text_exporter.new(text_element).export
+              end.join
+
+              "<li>#{line_item}</li>"
+            end.join
+          end
+
+          # @return [String]
+          def prepend_list_tag
+            ordered_list? ? '<ol>' : '<ul>'
+          end
+
+          # @return [String]
+          def append_list_tag
+            ordered_list? ? '</ol>' : '</ul>'
+          end
+
+          # @return [Boolean]
+          def ordered_list?
+            @element.list_type == :ordered
+          end
+        end
+      end
+    end
+  end
+end