social-url 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d01b5270b58b9764104d86befbc364c0e54004d
+  data.tar.gz: 5125800db737d0cc20621730b854b8f49a8257bd
+SHA512:
+  metadata.gz: a52bfabb0050d6aa28bf1ba9e6737338bb1c66f0ebdc65a7b2acb1aeda2bc805cb99d70b5da25025ffe4d0efe7d8c97036cac5c2dd1ff6e195947596b83b063d
+  data.tar.gz: 3034c2fb435822f2d8f8263270f433af7a6cc58f83a6a67cc8e10bd7f4089f07c84f40db510b79fe91aee700b151cbdd583e004e4796067ed260b9b0c21570f8

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    social-url (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    docile (1.1.5)
+    ffi (1.9.10)
+    formatador (0.2.5)
+    guard (2.12.8)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, <= 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.4)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    json (1.8.3)
+    listen (3.0.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    minitest (5.7.0)
+    nenv (0.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rb-fsevent (0.9.5)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    shellany (0.0.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codeclimate-test-reporter (~> 0.4)
+  guard (~> 2.12)
+  guard-minitest (~> 2.4)
+  rake (~> 10.4)
+  simplecov (~> 0.9)
+  social-url!
+
+BUNDLED WITH
+   1.10.5

data/Guardfile

@@ -0,0 +1,7 @@
+clearing :on
+
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$}) { |m| "test/lib/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$}) { 'test' }
+end

data/README.md

@@ -0,0 +1,65 @@
+# social_url
+
+A simple gem to generate social media sharing links.
+Supports multiple platforms with a plugin architecture.
+
+## Introduction
+
+This gem was created to help quickly set up sharing links for web pages. This should help you create simple and fast sharing links to social media networks as opposed to performance-heavy third-party sharing widgets.
+
+Read more about (https://jonsuh.com/blog/social-share-links/)[Responsible Social Share Links].
+
+## Installation
+
+Add it to your Gemfile with:
+
+```ruby
+gem 'social_url'
+```
+
+Run the `bundle install` in your terminal command to install it.
+
+## Usage
+
+The gem exposes two classes `SocialUrl` and `SocialUrl::Message`. The `SocialUrl` class provides normalization functionality for URL parameters and exposes the available networks:
+
+```ruby
+SocialUrl.networks #=> [:twitter]
+
+SocialUrl.normalize_string('Hello World') #=> 'Hello%20World'
+SocialUrl.normalize_array(%w(nature sunset)) #=> 'nature,sunset'
+SocialUrl.normalize_array(['twitter:Twitter News', 'twitterapi:Twitter API News']) #=> 'twitter%3ATwitter%20News,twitterapi%3ATwitter%20API%20News'
+```
+
+Setup a new message to share on social networks using the `Message` class:
+
+```ruby
+message = SocialUrl::Message.new({
+  text: 'Hello World',
+  url: 'http://example.com',
+  hashtags: %w(nature sunset)
+})
+
+message.twitter_url #=> 'https://twitter.com/intent/tweet/?text=Hello%20World&url=http%3A%2F%2Fexample.com&hashtags=nature,sunset'
+```
+
+### Available networks
+
+- Facebook
+- Twitter
+
+## TODO
+
+This gem is a work-in-progress. Planned features:
+
+- Ruby on Rails ActionView helpers
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- Report bugs
+- Fix bugs and submit pull requests
+- Write, clarify, or fix documentation
+- Suggest or add new features
+- Write missing tests

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/social_url.rb

@@ -0,0 +1,42 @@
+require 'erb'
+require 'social_url/version'
+require 'social_url/message'
+require 'social_url/facebook'
+require 'social_url/twitter'
+
+module SocialUrl
+  include ERB::Util
+
+  class << self
+    NETWORKS = [:twitter]
+
+    def networks
+      NETWORKS
+    end
+
+    def normalize(options)
+      opts = {}
+
+      options.each do |key, value|
+        next unless value
+
+        opts[key] = normalize_string(value) if value.is_a?(String)
+        opts[key] = normalize_array(value) if value.is_a?(Array)
+      end
+
+      opts
+    end
+
+    def normalize_string(string)
+      ERB::Util.url_encode(string)
+    end
+
+    def normalize_array(array)
+      array.collect do |value|
+        ERB::Util.url_encode(value)
+      end.join(',')
+    end
+  end
+
+  class UnsupportedNetworkError < StandardError; end
+end

data/lib/social_url/facebook.rb

@@ -0,0 +1,13 @@
+module SocialUrl
+  class Facebook
+    def initialize(options)
+      @options = options
+    end
+
+    def url
+      params = "u=#{@options[:url]}"
+
+      "https://www.facebook.com/sharer/sharer.php?#{params}"
+    end
+  end
+end

data/lib/social_url/message.rb

@@ -0,0 +1,29 @@
+module SocialUrl
+  class Message
+    def initialize(options)
+      @options = SocialUrl.normalize(options)
+
+      init_networks
+    end
+
+    def method_missing(method)
+      network = /(.+)_url/.match(method)
+      return unless network
+
+      networks = SocialUrl.networks.join(',')
+      raise UnsupportedNetworkError,
+           "Unsupported network '#{network[1]}'. Choose from: #{networks}."
+    end
+
+    private
+
+    def init_networks
+      SocialUrl.networks.each do |network|
+        self.class.send(:define_method, "#{network}_url") do
+          klass = network.to_s.capitalize
+          SocialUrl.const_get(klass).new(@options).url
+        end
+      end
+    end
+  end
+end

data/lib/social_url/twitter.rb

@@ -0,0 +1,15 @@
+module SocialUrl
+  class Twitter
+    def initialize(options)
+      @options = options
+    end
+
+    def url
+      params = @options.collect do |key, value|
+        "#{key}=#{value}"
+      end.join('&')
+
+      "https://twitter.com/intent/tweet/?#{params}"
+    end
+  end
+end

data/lib/social_url/version.rb

@@ -0,0 +1,3 @@
+module SocialUrl
+  VERSION = '0.1.1'
+end

data/social-url.gemspec

@@ -0,0 +1,24 @@
+require './lib/social_url/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'social-url'
+  s.version     = SocialUrl::VERSION
+  s.authors     = ["Richard Venneman"]
+  s.email       = 'richardvenneman@me.com'
+  s.homepage    = 'https://github.com/richardvenneman/social-url'
+  s.summary     = 'Generates social media sharing links'
+  s.description = 'A simple gem to generate social sharing links from your
+                   messages. Supports multiple social platforms trough a plugin
+                   architecture.'
+
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = Dir['test/**/*']
+
+  s.add_development_dependency 'rake', '~> 10.4'
+  s.add_development_dependency 'guard', '~> 2.12'
+  s.add_development_dependency 'guard-minitest', '~> 2.4'
+  s.add_development_dependency 'simplecov', '~> 0.9'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+end

data/test/lib/social_url/facebook_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+module SocialUrl
+  class FacebookTest < Minitest::Test
+    def setup
+      @options = { url: 'http://example.com' }
+    end
+
+    def test_url
+      url = 'https://www.facebook.com/sharer/sharer.php?u=http%3A%2F%2Fexample.com'
+
+      opts = SocialUrl.normalize(@options)
+      assert_equal url, Facebook.new(opts).url
+    end
+  end
+end

data/test/lib/social_url/message_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+module SocialUrl
+  class MessageTest < Minitest::Test
+    def test_exposes_network_methods
+      message = Message.new({})
+
+      SocialUrl.networks.each do |network|
+        method = "#{network}_url".to_sym
+        assert_respond_to message, method
+      end
+    end
+
+    def test_throws_on_invalid_network
+      message = Message.new({})
+
+      assert_raises UnsupportedNetworkError do
+        message.derp_url
+      end
+    end
+
+    def test_network_url
+      message = Message.new({
+        text: 'Hello World',
+        url: 'http://example.com',
+        hashtags: %w(nature sunset),
+        via: 'twitterdev',
+        related: ['twitter:Twitter News', 'twitterapi:Twitter API News']
+      })
+
+      url = ['https://twitter.com/intent/tweet/?text=Hello%20World',
+             '&url=http%3A%2F%2Fexample.com',
+             '&hashtags=nature,sunset',
+             '&via=twitterdev',
+             '&related=twitter%3ATwitter%20News,twitterapi%3ATwitter%20API%20News'].join
+
+      assert_equal url, message.twitter_url
+    end
+  end
+end

data/test/lib/social_url/twitter_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module SocialUrl
+  class TwitterTest < Minitest::Test
+    def setup
+      @options = {
+        text: 'Hello World',
+        url: 'http://example.com',
+        hashtags: %w(nature sunset),
+        via: 'twitterdev',
+        related: ['twitter:Twitter News', 'twitterapi:Twitter API News']
+      }
+    end
+
+    def test_url
+      url = ['https://twitter.com/intent/tweet/?text=Hello%20World',
+             '&url=http%3A%2F%2Fexample.com',
+             '&hashtags=nature,sunset',
+             '&via=twitterdev',
+             '&related=twitter%3ATwitter%20News,twitterapi%3ATwitter%20API%20News'].join
+
+      opts = SocialUrl.normalize(@options)
+      assert_equal url, Twitter.new(opts).url
+    end
+  end
+end

data/test/lib/social_url_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class SocialUrlTest < Minitest::Test
+  def test_exposes_available_networks
+    assert_kind_of Array, SocialUrl.networks
+    assert_includes SocialUrl.networks, :twitter
+  end
+
+  def test_string_normalization
+    text = 'Hello%20World'
+
+    assert_equal text, SocialUrl.normalize_string('Hello World')
+  end
+
+  def test_array_normalization
+    array = %w(nature sunset)
+    text = 'nature,sunset'
+    complex_array = ['twitter:Twitter News', 'twitterapi:Twitter API News']
+    complex_text = 'twitter%3ATwitter%20News,twitterapi%3ATwitter%20API%20News'
+
+    assert_equal text, SocialUrl.normalize_array(array)
+    assert_equal complex_text, SocialUrl.normalize_array(complex_array)
+  end
+
+  def test_normalization
+    options = {
+      text: 'Hello World',
+      url: 'http://example.com/',
+      hashtags: %w(nature sunset),
+      via: 'twitterdev',
+      related: ['twitter:Twitter News', 'twitterapi:Twitter API News']
+    }
+
+    normalized_options = {
+      text: 'Hello%20World',
+      url: 'http%3A%2F%2Fexample.com%2F',
+      hashtags: 'nature,sunset',
+      via: 'twitterdev',
+      related: 'twitter%3ATwitter%20News,twitterapi%3ATwitter%20API%20News'
+    }
+
+    assert_equal normalized_options, SocialUrl.normalize(options)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+# Coverage
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+elsif ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_group 'Libraries', 'lib'
+  end
+end
+
+# Source files
+require './lib/social_url'
+
+# Support
+require 'minitest/autorun'
+require 'minitest/pride'

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: social-url
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Richard Venneman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: |-
+  A simple gem to generate social sharing links from your
+                     messages. Supports multiple social platforms trough a plugin
+                     architecture.
+email: richardvenneman@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- Rakefile
+- lib/social_url.rb
+- lib/social_url/facebook.rb
+- lib/social_url/message.rb
+- lib/social_url/twitter.rb
+- lib/social_url/version.rb
+- social-url.gemspec
+- test/lib/social_url/facebook_test.rb
+- test/lib/social_url/message_test.rb
+- test/lib/social_url/twitter_test.rb
+- test/lib/social_url_test.rb
+- test/test_helper.rb
+homepage: https://github.com/richardvenneman/social-url
+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.8
+signing_key: 
+specification_version: 4
+summary: Generates social media sharing links
+test_files:
+- test/lib/social_url/facebook_test.rb
+- test/lib/social_url/message_test.rb
+- test/lib/social_url/twitter_test.rb
+- test/lib/social_url_test.rb
+- test/test_helper.rb