social_linker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44693d7049496654e418b3baeb7d3d5480583396
+  data.tar.gz: afb9f90e4bcd35e49df107244a9d4a7cb0803ba6
+SHA512:
+  metadata.gz: 8421d72c3578625c81353d66907ba4bf8695b1e97c9c370a816d1f2f4088ac2c9a43aa9fd5ff8ebbc623f60c74760e8fc992b7487bbcbcab5ec94f95f3a5e78b
+  data.tar.gz: 23bed364f087ceb4eb1d06959980c3ec95a71e216dbeb01c439d47d73d17a446176ca61bc2c8fcf31b60757c5175a1e78a911538a8e13962bc1c63fa0bebaa26

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at info@murb.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in social_linker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 murb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'social_linker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install social_linker
+
+## Usage
+
+Initialize the subject with enough material to generate links from, such as the page's url, maybe the image url (mainly for Pinterest type-shares), a description, tags etc.
+
+For example, initialze
+
+```ruby
+social_linker_subject = SocialLinker::Subject.new(media: "http://example.com/img.jpg", url: "http://example.com/", title: "Example website", description: "Example.com is the typical URL you would want to use in explanations anyway."
+```
+
+You'll get the e-mail share url by calling:
+
+```ruby
+social_linker_subject.share_link(:mail)
+```
+
+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:
+
+    [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)
+
+The supported options are:
+
+* url
+* media (media url, e.g. an image (now only Pinterest))
+* summary
+* description
+* title
+* tags
+
+I've tried to map them as good as possible to the different share tools. Sometimes by combining several values. You may also pass along link-specific parameters such as `:status` (for twitter), so no status is generated from the link, the title and the tags (make sure that you include a link though).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/murb/social_linker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "social_linker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/social_linker/version.rb

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

data/lib/social_linker.rb

@@ -0,0 +1,110 @@
+require "social_linker/version"
+require "erb"
+include ERB::Util
+
+module SocialLinker
+  class Subject
+    SHARE_TEMPLATES = {
+      email: {
+        base: "mailto:emailaddress?",
+        params: [:subject,:body,:cc,:bcc]
+      },
+      pinterest: {
+        base: "https://pinterest.com/pin/create/button/?",
+        params: [:url, :media, :description]
+      },
+      linkedin: {
+        base: "https://www.linkedin.com/shareArticle?mini=true&",
+        params: [:url, :title, :summary, :source]
+      },
+      google: {
+        base: "https://plus.google.com/share?",
+        params: [:url]
+      },
+      twitter: {
+        base: "https://twitter.com/home?",
+        params: [:status]
+      },
+      facebook: {
+        base: "https://www.facebook.com/sharer/sharer.php?",
+        params: [:u]
+      }
+
+    }
+
+    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
+        puts "WARNING: string of tags longer than adviced lenght of 60 characters: #{string}"
+      end
+      string
+    end
+
+    def quote_string(string)
+      "“#{string}”" if string and string.to_s.strip != ""
+    end
+
+    def strip_string(string, max_length=100)
+      if string and string.length > max_length
+        elipsis = "…"
+        if string[-1] == "”"
+          elipsis = "#{elipsis}”"
+        end
+        max_char = max_length-1-elipsis.length
+        string = string[0..max_char]+elipsis
+      end
+      string
+    end
+
+    # options accepts:
+    # * tags
+    # * url
+    # * title
+    # * image_url
+
+    def initialize(options={})
+      @options = options
+      @options[:u] = @options[:url] unless options[:u]
+      @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[: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
+        @options[:status] = "#{quote_string(strip_string(@options[:title],max_length))} #{@options[:url]} #{hash_string}"
+      end
+
+      unless @options[:body]
+        @options[:body] = ""
+        @options[:body] += "#{@options[:summary]}\n" if @options[:summary]
+        @options[:body] += "\n#{@options[:url]}\n" if @options[:url]
+        @options[:body] += "\n#{@options[:description]}\n" if @options[:summary] != @options[:description] and @options[:description]
+        @options[:body] += "\n#{@options[:media]}\n" if @options[:media] != @options[:url] and @options[:media]
+        @options[:body] += "\n\n#{hashtag_string(@options[:tags])}" if @options[:tags]
+        @options[:body] = nil if @options[:body].strip == ""
+      end
+
+      @options.each do |k,v|
+        @options[k] = v.strip if v and v.is_a? String
+      end
+    end
+
+    def options
+      @options
+    end
+
+    def share_link(platform)
+      share_options = SHARE_TEMPLATES[platform]
+      params = options.keys & share_options[:params]
+      if params.include?(:description) and !params.include?(:title)
+        @options[:description] = @options[:title]
+      end
+
+      return share_options[:base]+params.collect{|k| "#{k}=#{url_encode(options[k])}"}.join('&')
+    end
+  end
+end

data/social_linker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'social_linker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "social_linker"
+  spec.version       = SocialLinker::VERSION
+  spec.authors       = ["murb"]
+  spec.email         = ["info@murb.nl"]
+
+  spec.summary       = "Social linker generates share-links for the different social networks from a simple SocialLinker::Subject class"
+  spec.description   = "Social linker generates share-links for the different social networks from a simple SocialLinker::Subject class.
+
+Supported networks are: Twitter, Facebook, LinkedIn, Google+, Pinterest, and email"
+  spec.homepage      = "https://murb.nl/blog?tags=social_linker"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: social_linker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- murb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Social linker generates share-links for the different social networks from a simple SocialLinker::Subject class.
+
+  Supported networks are: Twitter, Facebook, LinkedIn, Google+, Pinterest, and email
+email:
+- info@murb.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/social_linker.rb
+- lib/social_linker/version.rb
+- social_linker.gemspec
+homepage: https://murb.nl/blog?tags=social_linker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Social linker generates share-links for the different social networks from
+  a simple SocialLinker::Subject class
+test_files: []
+has_rdoc: