social_linker 0.4.0.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59bcefeedf62a3ce08a9eab43dc14b9ca845e1a5
-  data.tar.gz: c620eaa12a11d5a373d568cc136e8b389f60d476
+  metadata.gz: c0dbc4dbe4ad685bd7760c48fe3dac052a188032
+  data.tar.gz: f16384779b4de79aa9967b7725eb4cc7513a4f99
 SHA512:
-  metadata.gz: a976bc35388ac0b0cd20cf145fe136919c6fbaa88e41522d6f8bcd89012dc97c3c35fe24e57940c646390b0c1a481e83500328758cd4ba019d39c60cb65a3d40
-  data.tar.gz: 01ec68d34385a00b71f80f54185018ae03eea2e19359b56ecf4656dc16c7d47fb20eda8df40b293adcdb29f7199098f1552995326964268fa592d8518eb4a953
+  metadata.gz: dee63ce241837647b68683a93f3bd285163b8d0d5511b03c6a794aa6689f7a81b1eef3e10c28c9468a179107fa956a578d88e48b3afb354376bf1a4f57c8dc5a
+  data.tar.gz: 4e0d002887b6b7aba2959883a31ae2bedba65483c3f099657a59fd486907bf2190143c6ed1d5995270506d7c873ab717950cbc4d5b5444461b7430733761a123

data/README.md

@@ -56,7 +56,7 @@ Which will deliver you the following url:
 The supported options are:
 
 * url
-* media (media url, e.g. an image (now only Pinterest))
+* media (media url, e.g. an image (shared only for Pinterest, but also used in OpenGraph headers & Twitter Cards))
 * summary
 * description
 * title
@@ -76,8 +76,8 @@ For example:
     @subject = SocialLinker::Subject.new(
       title: "title",
       url: "https://murb.nl/blog",
-      image_url: "https://murb.nl/image.jpg",
-      image_type: 'image/jpeg',
+      media: "https://murb.nl/image.jpg",
+      media_dimensions: [640, 480],
       summary: "short summary",
       tags: ["key1", "key2", "key3"],
     )
@@ -97,12 +97,24 @@ ApplicationController. Later on you can merge details into this subject:
     @subject.merge!({
       title: "title",
       url: "https://murb.nl/blog",
-      image_url: "https://murb.nl/image.jpg",
-      image_type: 'image/jpeg',
+      media: "https://murb.nl/image.jpg",
+      media_dimensions: [640, 480],
       summary: "short summary",
       tags: ["key1", "key2", "key3"]
     })
 
+*Hint*, the media_dimensions are 'compatible' with the output of the Dimensions-gem:
+
+    @subject.merge!({
+      title: @article.title,
+      url: article_url(@article),
+      media: @article.image.url(:inline),
+      media_dimensions: Dimensions.dimensions(@article.image.path(:inline)),
+      summary: @article.description,
+      tags: @article.tag_list.to_a
+    })
+
+
 ### Creating share links
 
 

data/app/helpers/view_helpers.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
 module ViewHelpers
   # renders a metatag
   # param [String, Symbol] name (or property) (defaults to name, values starting with 'og:' (opengraph) will be using the property attribute)
   # param [String, Symbol] content (the value for the name or the property)
   # @returns [String, nil] nil is returned when the content is empty
   def meta_tag(name, content)
-    content = erb_sanitized(content)
-    name = erb_sanitized(name)
+    key_value_pairs = {}
     name_or_property_attribute = if (name.start_with?("og:") or name.start_with?("fb:"))
         "property"
       elsif ['Content-Language'].include? name
@@ -13,7 +13,27 @@ module ViewHelpers
       else
         "name"
     end
-    "<meta #{name_or_property_attribute}=\"#{name}\" content=\"#{content}\" />" if content and content.to_s.strip != ""
+    key_value_pairs[name_or_property_attribute] = name
+    key_value_pairs[:content] = content
+    tag_if(:meta, key_value_pairs, :content)
+  end
+
+  # renders a tag conditionally (if value is said)
+  # param [String, Symbol] tagname of the tag
+  # param [Hash] key value pairs (the attributes and their corresponding values
+  # param [String, Symbol] if_key is the key to be checked for containing a value, otherwise nil is returned, defaults to :content
+  # @returns [String, nil] nil is returned when the if_key is empty
+  def tag_if(tagname, key_value_pairs, if_key=:content)
+    tag = tagname.to_sym
+    critical_value = key_value_pairs[if_key]
+    if critical_value and critical_value.to_s.strip != ""
+      attribs = key_value_pairs.collect do |k,v|
+        key = erb_sanitized(k)
+        value = erb_sanitized(v)
+        rv = "#{key}=\"#{value}\""
+      end.join(" ")
+      "<#{tag} #{attribs} />"
+    end
   end
 
   def erb_sanitized(value)
@@ -40,8 +60,15 @@ module ViewHelpers
 
     header_html = []
 
+    # <link href="https://plus.google.com/+YourPage" rel="publisher">
+    #     <meta itemprop="name" content="Content Title">
+    #     <meta itemprop="description" content="Content description less than 200 characters">
+    #     <meta itemprop="image" content="http://example.com/image.jpg">
+    # =
+
     header_html << meta_tag("twitter:site", options[:twitter_username])
     header_html << meta_tag("twitter:creator", options[:twitter_username])
+    header_html << tag_if(:link, {href: "https://plus.google.com/+#{options[:google_plus_name]}", rel: "publisher"}, :href) if options[:google_plus_name]
     header_html << meta_tag("twitter:domain", domain)
     header_html << meta_tag("Content-Language", language)
     header_html << meta_tag("dc.language", language)
@@ -61,12 +88,15 @@ module ViewHelpers
 
       header_html << meta_tag("twitter:description", subject.summary(true))
       header_html << meta_tag("og:description", subject.summary(false))
-
+      header_html << tag_if(:meta, {itemprop: :description, content: subject.summary(false)})
 
       if subject.media
         header_html << meta_tag("twitter:image:src", subject.media)
         header_html << meta_tag("og:image", subject.media)
-        header_html << meta_tag("og:image:type", subject.options[:image_type])
+        header_html << meta_tag("og:image:width", subject.media_width)
+        header_html << meta_tag("og:image:height", subject.media_height)
+        header_html << meta_tag("og:image:type", subject.image_type)
+        header_html << tag_if(:meta, {itemprop: :image, content: subject.media})
       end
     end
 
@@ -77,6 +107,8 @@ module ViewHelpers
     header_html << meta_tag("twitter:title", title)
     header_html << meta_tag("og:title", title)
     header_html << meta_tag("og:site_name", site_name)
+    header_html << tag_if(:meta, {itemprop: :name, content: site_title}, :content)
+
 
     header_html.compact!
     header_html = header_html.join("\n") if header_html

data/lib/social_linker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "social_linker/version"
 require "social_linker/subject"
 require 'social_linker/engine' if defined?(Rails)

data/lib/social_linker/engine.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SocialLinker
   class Engine < ::Rails::Engine
     isolate_namespace SocialLinker

data/lib/social_linker/subject.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SocialLinker
   class Subject
 
@@ -77,12 +78,60 @@ module SocialLinker
       @options[:image_url]
     end
 
-    def utm_parameters
+    def media_dimensions
+      return @media_dimensions if @media_dimensions
+      if media
+        @media_dimensions = @options[:media_dimensions]
+        if @media_dimensions.is_a? Array
+          @media_dimensions = {
+            width: @media_dimensions[0],
+            height: @media_dimensions[1]
+          }
+        end
+        @media_dimensions ||= {
+          width: @options[:media_width],
+          height: @options[:media_height]
+        }
+      else
+        @media_dimensions = {}
+      end
+    end
+
+    def media_width
+      media_dimensions[:width].to_i if media_dimensions[:width]
+    end
+
+    def media_height
+      media_dimensions[:height].to_i if media_dimensions[:height]
+    end
+
+    def utm_parameters?
       [nil, true].include?(@options[:utm_parameters]) ? true : false
     end
 
+    def utm_parameters
+      if utm_parameters?
+        {
+          utm_source: "<%=share_source%>",
+          utm_medium: "share_link",
+          utm_campaign: "social"
+        }
+      end
+    end
+
     def canonical_url
-      @options[:canonical_url]
+      prefix_domain((@options[:canonical_url] || @options[:url]), @options[:domain])
+    end
+
+    def share_url
+      url_to_share = prefix_domain((@options[:share_url] || @options[:url]), @options[:domain])
+      if utm_parameters?
+        utm_url_params = utm_parameters.collect{|k,v| "#{k}=#{v}" unless url_to_share.match(k.to_s)}.compact.join("&")
+        combine_with = url_to_share.match(/\?/) ? "&" : "?"
+        return "#{url_to_share}#{combine_with}#{utm_url_params}"
+      else
+        return url_to_share
+      end
     end
 
     # default title accessor
@@ -94,7 +143,8 @@ module SocialLinker
     # default summary accessor
     # @return String with summary
     def summary(strip=false)
-      strip ? strip_string(@options[:summary], 300) : @options[:summary]
+      summ = @options[:summary] || @options[:description]
+      strip ? strip_string(summ, 300) : summ
     end
 
     # default media accessor
@@ -103,6 +153,23 @@ module SocialLinker
       @options[:media]
     end
 
+    def filename_derived_image_type
+      if media
+        extension = media.to_s.split(".").last.downcase
+        if extension == "jpg" or extension == "jpeg"
+          "image/jpeg"
+        elsif extension == "png"
+          "image/png"
+        elsif extension == "gif"
+          "image/gif"
+        end
+      end
+    end
+
+    def image_type
+      @options[:image_type] || filename_derived_image_type
+    end
+
     # default tags accessor
     # @return Array<String> with tags
     def tags
@@ -142,6 +209,7 @@ module SocialLinker
     # * url
     # * title
     # * image_url & image_type(image/jpeg, image/png)
+    # * width and height for the images
     # * description
     # * facebook_app_id
     # * twitter_username
@@ -180,38 +248,18 @@ module SocialLinker
     # @return SocialLinker::Subject (self)
     def merge!(options)
       options = options.options if options.is_a? SocialLinker::Subject
+      options[:render_site_title_postfix] = true if options[:render_site_title_postfix].nil?
+      options[:u] ||= options[:url]
+      options[:media] ||= options[:image_url]
+      options[:title] ||= "#{ strip_string(options[:summary], 120) }"
+      options[:subject] ||= options[:title]
+      options[:via] ||= options[:twitter_username]
+      options[:url] ||= options[:media]
+      options[:text] = "#{options[:title]} #{options[:url]}" unless options[:text] #facebook & whatsapp native
+      options[:domain] = options[:url].split(/\//)[0..2].join("/") if options[:url] and !options[:domain]
+      options.select!{|k,v| !v.nil?}
       @options.merge!(options)
-      @options[:render_site_title_postfix] = true if @options[:render_site_title_postfix].nil?
-      @options[:u] = @options[:url] unless @options[:u]
-      @options[:media] = @options[:image_url] unless @options[:media]
-      @options[:description] = @options[:summary] unless @options[:description]
-      @options[:summary] = @options[:description] unless @options[:summary]
-      @options[:title] = "#{ strip_string(@options[:summary], 120) }" unless @options[:title]
-      @options[:description] = @options[:title] unless @options[:description]
-      @options[:subject] = @options[:title] unless @options[:subject]
-      @options[:via] = @options[:twitter_username] unless @options[:via]
-      @options[:url] = @options[:media] unless @options[:url]
-      raise ArgumentError, "#{url} is not a valid url" if @options[:url] and !@options[:url].include?('//')
-
-      @options[:text] = "#{@options[:title]} #{@options[:url]}" unless @options[:text] #facebook & whatsapp native
-      @options[:canonical_url] = @options[:url]
-      @options[:share_url] = @options[:url]
-      @options[:domain] = @options[:url].split(/\//)[0..2].join("/") if @options[:url] and !@options[:domain]
-
-      if @options[:share_url] and utm_parameters
-        unless @options[:share_url].match /utm_source/
-          combine_with = @options[:share_url].match(/\?/) ? "&" : "?"
-          @options[:share_url] = "#{@options[:share_url]}#{combine_with}utm_source=<%=share_source%>"
-        end
-        unless @options[:share_url].match /utm_medium/
-          combine_with = "&"
-          @options[:share_url] = "#{@options[:share_url]}#{combine_with}utm_medium=share_link"
-        end
-        unless @options[:share_url].match /utm_campaign/
-          combine_with = "&"
-          @options[:share_url] = "#{@options[:share_url]}#{combine_with}utm_campaign=social"
-        end
-      end
+
       if @options[:tags]
         @options[:tags].compact!
         @options[:hashtags] = @options[:tags][0..1].collect{|a| camelize_tag_when_needed(a) }.join(",") if @options[:tags] and !@options[:hashtags]
@@ -219,8 +267,6 @@ module SocialLinker
 
       # make sure urls are absolute
       @options[:url] = prefix_domain(@options[:url],@options[:domain])
-      @options[:share_url] = prefix_domain(@options[:share_url],@options[:domain])
-      @options[:canonical_url] = prefix_domain(@options[:canonical_url],@options[:domain])
       @options[:image_url] = prefix_domain(@options[:image_url],@options[:domain])
       @options[:media] = prefix_domain(@options[:media],@options[:domain])
 
@@ -236,16 +282,20 @@ module SocialLinker
     def body
       return options[:body] if options[:body]
       rv = ""
-      rv += "#{@options[:summary]}\n" if options[:summary]
-      rv += "\n#{@options[:share_url]}\n" if options[:share_url]
-      rv += "\n#{@options[:description]}\n" if options[:summary] != options[:description] and options[:description]
-      rv += "\n#{@options[:media]}\n" if options[:media] != options[:share_url] and options[:media]
+      rv += "#{summary}\n" if summary
+      rv += "\n#{share_url}\n" if share_url
+      rv += "\n#{description}\n" if summary != description and description
+      rv += "\n#{@options[:media]}\n" if options[:media] != share_url and options[:media]
       rv += "\n\n#{hashtag_string(@options[:tags])}" if options[:tags]
       rv.strip!
       rv = nil if rv == ""
       return rv
     end
 
+    def description
+      @options[:description] || @options[:summary]
+    end
+
     # Turns the first two tags in to tweetable hash tags
     # Conform recommendation never to have more than 2 tags in a twitter message
     # @return String with two tags as #tags.
@@ -278,13 +328,14 @@ module SocialLinker
     # @param [String] domain of the file
     # @return String with full url
     def prefix_domain path, domain
-      return_string = path
       if path and !path.include?("//")
-        path.gsub!(/^\//,'')
-        domain.gsub!(/\/$/,'')
-        return_string = [domain,path].join("/")
+        return [
+          domain.gsub(/\/$/,''),
+          path.gsub(/^\//,'')
+        ].join("/")
+      else
+        return path
       end
-      return_string
     end
 
     # Returns the given options, extended with the (derived) defaults
@@ -331,5 +382,4 @@ module SocialLinker
       end
     end
   end
-end
-
+end

data/lib/social_linker/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SocialLinker
-  VERSION = "0.4.0.2"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_linker
 version: !ruby/object:Gem::Version
-  version: 0.4.0.2
+  version: 0.5.0
 platform: ruby
 authors:
 - murb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2018-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler