social_linker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44693d7049496654e418b3baeb7d3d5480583396
-  data.tar.gz: afb9f90e4bcd35e49df107244a9d4a7cb0803ba6
+  metadata.gz: 6036e3cb0b45698770be9b32a5030ee099fffe83
+  data.tar.gz: e9a5d85d8e26ff3da2c85012965b673704cbbb04
 SHA512:
-  metadata.gz: 8421d72c3578625c81353d66907ba4bf8695b1e97c9c370a816d1f2f4088ac2c9a43aa9fd5ff8ebbc623f60c74760e8fc992b7487bbcbcab5ec94f95f3a5e78b
-  data.tar.gz: 23bed364f087ceb4eb1d06959980c3ec95a71e216dbeb01c439d47d73d17a446176ca61bc2c8fcf31b60757c5175a1e78a911538a8e13962bc1c63fa0bebaa26
+  metadata.gz: 51cc1e4caa195d860cc5a3ce535b5e871f1d0e611bab09a160a3863966ab072f65b0260e2fcdb7c94fc2f6197b0665ab13bab774e44dd5f5a3d71ee92a9be245
+  data.tar.gz: 2c025dd4c94309859b8821e8ddb2678abbea5a622bc81567871cc80d978b08be365b497c257e0f3acb96d4931d8644b1bea12186c22ef11e69149ffd7e2eea9f

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,6 +1,6 @@
 # SocialLinker
 
-SocialLinker is able to generate the most needed share links for you. You should use generated links, instead of the share buttons provided by the platforms themselves, to protect your user's privacy, and this gem makes it easy for you to do so.
+SocialLinker is able to generate the most common share links for you, without depending on JavaScript. You should use generated links, instead of the share buttons provided by the platforms themselves, to protect your user's privacy, and this gem makes it easy for you to do so.
 
 ## Installation
 
@@ -38,9 +38,9 @@ Which will deliver you the following url:
 
     mailto:emailaddress?subject=Example%20website&body=Example.com%20is%20the%20typical%20URL%20you%20would%20want%20to%20use%20in%20explanations%20anyway.%0A%0Ahttp%3A%2F%2Fexample.com%2F
 
-Or to save you the copy paste:
+Or to save you the copy-paste:
 
-    [TestMailLink](mailto:mailto:emailaddress?subject=Example%20website&body=Example.com%20is%20the%20typical%20URL%20you%20would%20want%20to%20use%20in%20explanations%20anyway.%0A%0Ahttp%3A%2F%2Fexample.com%2F)
+[TestMailLink](mailto:emailaddress?subject=Example%20website&body=Example.com%20is%20the%20typical%20URL%20you%20would%20want%20to%20use%20in%20explanations%20anyway.%0A%0Ahttp%3A%2F%2Fexample.com%2F)
 
 The supported options are:
 

data/lib/social_linker.rb

@@ -3,7 +3,13 @@ require "erb"
 include ERB::Util
 
 module SocialLinker
+
+  # The main class of SocialLinker is the `SocialLinker::Subject`-class.
   class Subject
+
+    # Constant defining how the different share-url's look like and their parameters;
+    # the parameters can be set in the options directly, or will be derived from more
+    # generic options
     SHARE_TEMPLATES = {
       email: {
         base: "mailto:emailaddress?",
@@ -32,6 +38,10 @@ module SocialLinker
 
     }
 
+    # convert an array of strings to a Twitter-like hashtag-string
+    #
+    # @param [Array] tags to be converted to string
+    # @return [String] containing a Twitter-style tag-list
     def hashtag_string(tags)
       string = (tags and tags.count > 0) ? "##{tags.collect{|a| a.to_s.strip.gsub('#','')}.join(" #")}" : nil
       if string and string.length > 60
@@ -40,10 +50,47 @@ module SocialLinker
       string
     end
 
+    # default url accessor
+    #
+    # @return String with url
+    def url
+      @options[:url]
+    end
+
+    # default title accessor
+    # @return String with title
+    def title
+      @options[:title]
+    end
+
+    # default summary accessor
+    # @return String with summary
+    def summary
+      @options[:summary]
+    end
+
+    # default media accessor
+    # @return String with media-url
+    def media
+      @options[:media]
+    end
+
+    # default tags accessor
+    # @return Array<String> with tags
+    def tags
+      @options[:media]
+    end
+
+    # puts quotes around a string
+    # @return [String] now with quotes.
     def quote_string(string)
       "“#{string}”" if string and string.to_s.strip != ""
     end
 
+    # strips a string to the max length taking into account quoting
+    # @param [String] string that is about to be shortened
+    # @param [Integer] max_length of the string to be shortened (default 100)
+    # @return [String] shortened to the max lenght
     def strip_string(string, max_length=100)
       if string and string.length > max_length
         elipsis = "…"
@@ -56,12 +103,15 @@ module SocialLinker
       string
     end
 
+    # Initialize the SocialLinker::Subject
+    #
     # options accepts:
     # * tags
     # * url
     # * title
     # * image_url
-
+    #
+    # @params [hash] options as defined above
     def initialize(options={})
       @options = options
       @options[:u] = @options[:url] unless options[:u]
@@ -73,8 +123,8 @@ module SocialLinker
       @options[:url] = @options[:media] unless @options[:url]
 
       unless @options[:status]
-        hash_string = hashtag_string(@options[:tags])
-        max_length = (hash_string ? hash_string.length : 0) + 12 + 4 #hashstring + url length (shortened) + spaces
+        hash_string = @options[:tags] ? hashtag_string(@options[:tags][0..2]) : ""
+        max_length = 140 - ((hash_string ? hash_string.length : 0) + 12 + 4) #hashstring + url length (shortened) + spaces
         @options[:status] = "#{quote_string(strip_string(@options[:title],max_length))} #{@options[:url]} #{hash_string}"
       end
 
@@ -93,12 +143,19 @@ module SocialLinker
       end
     end
 
+    # Returns the given options, extended with the (derived) defaults
+    #
+    # @return Hash with the options
     def options
       @options
     end
 
+    # Generates a share link for each of the predefined platforms in the `SHARE_TEMPLATES` constant
+    #
+    # @param [Symbol] platform to generate the link for
     def share_link(platform)
       share_options = SHARE_TEMPLATES[platform]
+      raise "No share template defined" unless share_options
       params = options.keys & share_options[:params]
       if params.include?(:description) and !params.include?(:title)
         @options[:description] = @options[:title]
@@ -106,5 +163,17 @@ module SocialLinker
 
       return share_options[:base]+params.collect{|k| "#{k}=#{url_encode(options[k])}"}.join('&')
     end
+
+    # Catches method missing and tries to resolve them in either an appropriate share link or option value
+    def method_missing(m,*args)
+      share_link_matcher = m.to_s.match(/([a-z]*)_share_link/)
+      if share_link_matcher
+        return share_link(share_link_matcher[1].to_sym)
+      elsif options[m]
+        return options[m]
+      else
+        super
+      end
+    end
   end
 end

data/lib/social_linker/version.rb

@@ -1,3 +1,3 @@
 module SocialLinker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: social_linker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - murb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler