article_json 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2820900cbe5eeba0352a764674bf7dbc1a5a1d2353c0fe5fcacea19799891378
-  data.tar.gz: 95c0cba7f4896556710fa621ea07576979b98ec62b7975e5ef330883f66b98b1
+  metadata.gz: baf39dbf5fb3f225088927c3ea9f7d58a59a502c6c70da1546829d857760ee6a
+  data.tar.gz: f9c60e3a2e8aadffda6525eb9acd085ee5ffcc53697cc7fec4a3c204209a571e
 SHA512:
-  metadata.gz: 0bd444a45513d39b0499188b7ade246cfde9e215df63b9652dc16435bde2570c51a4ed9cb5124c24a0848b63df3eacd3a2538bcb8ba5829b96b4afc7e5f93ff7
-  data.tar.gz: 4effc300873b4203bbc4e9594cc49ae871275e3d5c0e92940b10fad380e7c06acd1b42b14b869d00f28385102bb2c7646eca0424f4e9ca4957c7796fa497aaa1
+  metadata.gz: 28783003b3b27d4eca2e5141dd59967f0f2ee44f077726bd5935a8e9dfa49fbd482cac67d49f2bc69e66797cb6dff7c67093124887215423117df6bbed8c5840
+  data.tar.gz: 0ee51b7975ed3621a99abe34a4d2180c327e3a1a678539aa58ed40171d8bf0cf812c0b1478c49886418fb410eb8634ac3b20c8a00ed881da2edeb5f5e7bc469f

data/CHANGELOG.md

@@ -1,4 +1,11 @@
 # Changelog
+## 0.3.8 - 2020/7/31
+- **Improvements:**
+- Add a script to update oembed stubs fixtures.
+- Support for `alt` attribute in images.
+
+- **Fix:** Fix a bug when using the `[image-link-to: ]` tag.
+
 ## 0.3.7 - 2019/8/21
 - **Fix:** Only use https for soundcloud oembed api
 

data/README.md

@@ -53,6 +53,21 @@ $ ./bin/article_json_export_google_doc.rb $DOC_ID \
     | ./bin/article_json_export_html.rb
 ```
 
+You can also update all the different exported versions of the reference
+document (html, json, amp, facebook instant article and plain txt) by
+running the following command:
+
+```
+$ ./bin/update_reference_document.sh
+```
+
+When running the tests, we use some fixtures to mock the responses for oembed
+request, but these may change over time. To update them, run:
+
+```
+$ ./bin/update_oembed_request-stubs.sh
+```
+
 ### Configuration
 There are some configuration options that allow a more tailored usage of the
 `article_json` gem. The following code snippet gives an example for every

data/bin/article_json_export_amp.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# Simple script to read a JSON document and export it to AMP.
+#
+# Usage:
+#
+#   ./bin/article_json_export_amp.rb < my_document.json
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+require_relative '../lib/article_json'
+puts ArticleJSON::Article.from_json(ARGF.read).to_amp

data/bin/article_json_export_facebook.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# Simple script to read a JSON document and export it to Facebook Instant
+# Article.
+#
+# Usage:
+#
+#   ./bin/article_json_export_facebook.rb < my_document.json
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+require_relative '../lib/article_json'
+puts ArticleJSON::Article.from_json(ARGF.read).to_facebook_instant_article

data/bin/article_json_export_plain_text.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+#
+# Simple script to read a JSON document and export it to plain text.
+#
+# Usage:
+#
+#   ./bin/article_json_export_plain_text.rb < my_document.json
+#
+# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+require_relative '../lib/article_json'
+puts ArticleJSON::Article.from_json(ARGF.read).to_plain_text

data/bin/update_oembed_request-stubs.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env sh
+
+curl -X GET "https://vimeo.com/api/oembed.json?url=https://vimeo.com/42315417" | jq > spec/fixtures/vimeo_video_oembed.json
+
+curl -X GET "http://www.youtube.com/oembed?format=json&url=https://www.youtube.com/watch?v=_ZG8HBuDjgc" | jq > spec/fixtures/youtube_video_oembed.json
+
+curl -X GET "https://www.slideshare.net/api/oembed/2?format=json&url=https://www.slideshare.net/Devex/the-best-global-development-quotes-of-2012" |  jq > spec/fixtures/slideshare_oembed.json
+
+curl -X GET "https://api.twitter.com/1/statuses/oembed.json?align=center&url=https://twitter.com/d3v3x/status/554608639030599681" | jq > spec/fixtures/tweet_oembed.json
+
+curl -X GET 'https://soundcloud.com/oembed?format=json&url=https://soundcloud.com/rich-the-kid/plug-walk-1' | jq > spec/fixtures/soundcloud_oembed.json
+
+curl -X GET  'https://www.facebook.com/plugins/video/oembed.json?url=https://www.facebook.com/facebook/videos/1814600831891266'  | jq > spec/fixtures/facebook_video_oembed.json

data/bin/update_reference_document.sh

@@ -7,6 +7,9 @@ DOC_ID="1E4lncZE2jDkbE34eDyYQmXKA9O26BHUiwguz4S9qyE8"
 SOURCE_HTML_FILE="spec/fixtures/reference_document.html"
 JSON_FILE="spec/fixtures/reference_document_parsed.json"
 HTML_EXPORT_FILE="spec/fixtures/reference_document_exported.html"
+AMP_EXPORT_FILE="spec/fixtures/reference_document_exported.amp.html"
+FACEBOOK_EXPORT_FILE="spec/fixtures/reference_document_exported.facebook.html"
+PLAIN_TEXT_EXPORT_FILE="spec/fixtures/reference_document_exported.txt"
 
 # export the google doc to HTML
 ./bin/article_json_export_google_doc.rb ${DOC_ID} > ${SOURCE_HTML_FILE}
@@ -16,3 +19,12 @@ HTML_EXPORT_FILE="spec/fixtures/reference_document_exported.html"
 
 # convert the JSON export to HTML
 ./bin/article_json_export_html.rb < ${JSON_FILE} > ${HTML_EXPORT_FILE}
+
+# convert the JSON export to AMP
+./bin/article_json_export_amp.rb < ${JSON_FILE} > ${AMP_EXPORT_FILE}
+
+# convert the JSON export to Facebook Instant Article
+./bin/article_json_export_facebook.rb < ${JSON_FILE} > ${FACEBOOK_EXPORT_FILE}
+
+# convert the JSON export to plain text
+./bin/article_json_export_plain_text.rb < ${JSON_FILE} > ${PLAIN_TEXT_EXPORT_FILE}

data/lib/article_json/elements/image.rb

@@ -1,18 +1,20 @@
 module ArticleJSON
   module Elements
     class Image < Base
-      attr_reader :source_url, :caption, :float, :href
+      attr_reader :source_url, :caption, :float, :href, :alt
 
       # @param [String] source_url
       # @param [Array[ArticleJSON::Elements::Text]] caption
       # @param [Symbol] float
       # @param [String] href
-      def initialize(source_url:, caption:, float: nil, href: nil)
+      # @param [String] alt
+      def initialize(source_url:, caption:, float: nil, href: nil, alt: nil)
         @type = :image
         @source_url = source_url
         @caption = caption
         @float = float
         @href = href
+        @alt = alt
       end
 
       # Hash representation of this image element
@@ -24,6 +26,7 @@ module ArticleJSON
           float: float,
           caption: caption.map(&:to_h),
           href: href,
+          alt: alt,
         }
       end
 
@@ -35,7 +38,8 @@ module ArticleJSON
             source_url: hash[:source_url],
             caption: parse_hash_list(hash[:caption]),
             float: hash[:float]&.to_sym,
-            href: hash[:href]
+            href: hash[:href],
+            alt: hash[:alt]
           )
         end
       end

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

@@ -29,7 +29,7 @@ module ArticleJSON
 
             # @return [Nokogiri::XML::NodeSet]
             def image_node
-              create_element(:img, src: @element.source_url)
+              create_element(:img, src: @element.source_url, alt: @element.alt)
             end
 
             # @return [Nokogiri::XML::NodeSet]

data/lib/article_json/import/google_doc/html/image_parser.rb

@@ -19,6 +19,12 @@ module ArticleJSON
             @float_node = @node
           end
 
+          # The value of the image's `alt` attribute
+          # @return [String]
+          def alt
+            image_node.attribute('alt')&.value || ''
+          end
+
           # The value of the image's `src` attribute
           # @return [String]
           def source_url
@@ -54,7 +60,8 @@ module ArticleJSON
               source_url: source_url,
               float: float,
               caption: caption,
-              href: @href
+              href: @href,
+              alt: alt
             )
           end
 

data/lib/article_json/version.rb

@@ -1,3 +1,3 @@
 module ArticleJSON
-  VERSION = '0.3.7'
+  VERSION = '0.3.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: article_json
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.3.8
 platform: ruby
 authors:
 - Daniel Sager
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-21 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -111,9 +111,13 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE
 - README.md
+- bin/article_json_export_amp.rb
+- bin/article_json_export_facebook.rb
 - bin/article_json_export_google_doc.rb
 - bin/article_json_export_html.rb
+- bin/article_json_export_plain_text.rb
 - bin/article_json_parse_google_doc.rb
+- bin/update_oembed_request-stubs.sh
 - bin/update_reference_document.sh
 - lib/article_json.rb
 - lib/article_json/article.rb
@@ -229,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: JSON Format for News Articles & Ruby Gem