social_sharer 0.1.3.2 → 0.1.4.pre.alpha.pre.15

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 35b3b23f941979844de8c9befd7f13c7435509b5
-  data.tar.gz: 592add6af368f3a982f35733670e46db8a7ed089
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmMyMmE1MTA5YTU2MmU3MWU4NGYzODFkODZmMjQyZTZjYjdiNDFjZQ==
+  data.tar.gz: !binary |-
+    NDMyMjU0ZWQ2YWRmNDgxMjc2MGFjY2VjYjgxODNkOWM0YzMyMzE1MQ==
 SHA512:
-  metadata.gz: 8a906103fbc08bab80771e7b17094e6edc60f6ba87f92db057f9ac47418eb70e9af262bcc8287bc6b7c017fb06d82e0acf7c4c5b9c7e7f5eb04e96fd3dc59e3c
-  data.tar.gz: d2f42828dc72699a78929bcd91e9900824e49b8ea55d5c1d3e93b7b7f55037851016fc9f3a58a73a2537e30025fdda1efb11e465d86688d8b3a043c8a4392f0d
+  metadata.gz: !binary |-
+    ZTc5ZjY5ZDMyNzI1ZTA0ZmE3NmU2YmZhNjEyZGM4ZmZlMDIxNjE5MGRiNTZi
+    YmYwYjNmOTQ1MTc5MGM5MjMyMDBhMTZjYmUxM2QyNjRiYTJlNThmN2RlNTU4
+    YzM4ZTFhYWFhMWRkZDA4MjJkZDEwMWY1ZjA4NTRiNDVmYWI0NGQ=
+  data.tar.gz: !binary |-
+    MWY4MjBlODUzNzU0ZDBmNmQyZDdhYWJmYjE4YWZjZGNkMjcyN2RmOGU3NTgz
+    NDYxNzljZWEzOGE4OTgyYTY5MjdmZmU5OWJjMWI2ZGQ2MjZjOGU1ZjY0Nzc5
+    OGJiMjMxMjM1ZWRlYjNhNzFiMmQ3NGE3ODhjY2MzMWRlODc5YmY=

data/README.md

@@ -1 +1,131 @@
-# Social Sharer [![Build Status](https://img.shields.io/travis/thisisbd/social_sharer.svg)](https://travis-ci.org/thisisbd/social_sharer) [![Gem](https://img.shields.io/gem/v/social_sharer.svg)](https://rubygems.org/gems/social_sharer)
+# ![Social Sharer Logo][logo]
+By [BD Network][thisisbd].
+
+Social Sharer is a [Ruby on Rails][rails] [Gem][rubygems], allowing you to easily create Twitter and Facebook share dialogues.
+
+[![Build status][shield-build]][info-build]
+[![Gem Version][shield-gem]][info-gem]
+[![Code Coverage][shield-coverage]][info-coverage]
+[![License][shield-license]][info-license]
+
+## Key Features
+- Easy to configure
+- Easy to style
+- Kept up to date with changes share systems.
+
+
+## Getting Started
+### Installation
+Add this to your gemfile within your Rails project:
+
+```bash
+gem 'social_sharer', '0.1.4'
+```
+
+### Options
+#### Single share URL
+If you require a single URL to be shared across both social networks but require simple tracking, e.g. for Google 
+Analytics you can use the options listed below:
+
+```ruby
+{
+  url: 'http://thisisbd.com/',
+  twitter_message: 'This%20is%20BD'
+}
+```
+
+This would have Facebook link to: `http://thisisbd.com/?src=fb` 
+and your tweet contents would be: `This is BD http://thisisbd.com/?src=tw`
+
+You may also add an (optional) Twitter handle to be included into the message:
+
+```ruby
+{
+  url: 'http://thisisbd.com/',
+  twitter_handle: '@thisisbd',
+  twitter_message: 'This%20is%20BD'
+}
+```
+
+Your tweet contents would be: `This is BD via @thisisbd http://thisisbd.com/?src=tw`
+
+#### Multiple share URLs
+If you provide different URLs for each social network, or want more flexible control over the URLs users are sharing, 
+these options are for you:
+
+```ruby
+{
+  individual_settings: true,
+
+  twitter: {
+    url: 'http://thisisbd.com/twitter_url',
+    message: 'This%20is%20BD'
+  },
+
+  facebook: {
+    url: 'http://thisisbd.com/facebook_url'
+  }
+}
+```
+
+This would have Facebook link to: `http://thisisbd.com/facebook_url` 
+and your tweet contents would be: `This is BD http://thisisbd.com/twitter_url`
+
+You may also add an (optional) Twitter handle to be included into the message:
+
+```ruby
+{
+  individual_settings: true,
+
+  twitter: {
+    url: 'http://thisisbd.com/twitter_url',
+    handle: '@thisisbd',
+    message: 'This%20is%20BD'
+  },
+
+  facebook: {
+    url: 'http://thisisbd.com/facebook_url'
+  }
+}
+```
+
+This would have Facebook link to: `http://thisisbd.com/facebook_url` 
+and your tweet contents would be: `This is BD via @thisisbd http://thisisbd.com/twitter_url`
+
+### View Helper
+Within your view:
+
+```ruby
+<%= social_share_tags( @social_sharer_options ) %>
+```
+
+## Requirements
+Social Sharer requires [Ruby on Rails][rails] and has been tested on 4.x.
+
+
+## Contributing
+If you wish to submit a bug fix or feature, you can create a pull request and it will be merged pending a code review.
+
+1. Clone it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create a new Pull Request
+
+## License
+Social Sharer is licensed under the [MIT License][info-license].
+
+[logo]: https://raw.github.com/thisisbd/social_sharer/master/social_sharer_logo.png
+
+[thisisbd]: http://thisisbd.com/
+[rails]: http://rubyonrails.org/
+[rubygems]: https://rubygems.org/
+
+[info-coverage]: https://coveralls.io/github/thisisbd/social_sharer
+[info-license]: LICENSE
+[info-gem]: https://rubygems.org/gems/social_sharer
+[info-build]: https://travis-ci.org/thisisbd/social_sharer
+[shield-coverage]: https://img.shields.io/coveralls/thisisbd/social_sharer.svg
+[shield-license]: https://img.shields.io/badge/license-MIT-blue.svg
+[shield-gem]: https://img.shields.io/gem/v/social_sharer.svg
+[shield-build]: https://img.shields.io/travis/thisisbd/social_sharer/master.svg

data/lib/social_sharer/version.rb

@@ -1,3 +1,3 @@
 module SocialSharer
-  VERSION = '0.1.3.2'
+  VERSION = '0.1.4'
 end

data/lib/social_sharer/view_helpers.rb

@@ -7,14 +7,14 @@ module SocialSharer
       has_individual_settings = options[:individual_settings]
 
       twitter_url = has_individual_settings ? options[:twitter][:url] : options[:url]
-      twitter_url += '?src=tw'
+      twitter_url += '?src=tw' unless has_individual_settings
       twitter_url = CGI.escape( twitter_url )
 
       twitter_message = has_individual_settings ? options[:twitter][:message] : options[:twitter_message]
       twitter_handle = has_individual_settings ? options[:twitter][:handle] : options[:twitter_handle]
 
       facebook_url = has_individual_settings ? options[:facebook][:url] : options[:url]
-      facebook_url += '?src=fb'
+      facebook_url += '?src=fb' unless has_individual_settings
       facebook_url = CGI.escape( facebook_url )
 
       twitter_handle_text = if twitter_handle.nil?

data/social_sharer.gemspec

@@ -32,5 +32,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop', '~> 0.34.2'
   s.add_development_dependency 'rspec', '~> 3.0'
 
+  s.add_development_dependency 'coveralls'
+
   s.add_dependency 'rails', '~> 4.2'
 end

data/spec/lib/social_sharer_view_helpers_spec.rb

@@ -10,46 +10,88 @@ describe SocialSharer::ViewHelpers do
   describe '#social_share_tags' do
     context 'with valid options' do
       context 'without individual_settings set' do
-        before :each do
-          @options = {
-            url: 'http://thisisbd.com',
-            twitter_message: 'This is BD - A creative agency in London',
-            twitter_handle: '@thisisbd'
-          }
-        end
+        context 'with a twitter handle' do
+          before :each do
+            @options = {
+              url: 'http://thisisbd.com',
+              twitter_message: 'This is BD - A creative agency in London',
+              twitter_handle: '@thisisbd'
+            }
+          end
+
+          it 'generates the expected twitter tag' do
+            expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" class=\"social_share_tw\" onclick=\"popUp=window.open(&#39;http://twitter.com/intent/tweet?text=This is BD - A creative agency in London via @thisisbd http%3A%2F%2Fthisisbd.com%3Fsrc%3Dtw&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://twitter.com/\">Share on Twitter</a>")
+          end
 
-        it 'generates the expected twitter tag' do
-          # expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" onclick=\"popUp=window.open(&#39;http://twitter.com/intent/tweet?text=This is BD - A creative agency in London via @thisisbd - http://thisisbd.com?src=tw&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://twitter.com/\">Share on Twitter</a>")
+          it 'generates the expected facebook tag' do
+            expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" class=\"social_share_fb\" onclick=\"popUp=window.open(&#39;http://www.facebook.com/sharer.php?u=http%3A%2F%2Fthisisbd.com%3Fsrc%3Dfb&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://www.facebook.com/\">Share on Facebook</a>")
+          end
         end
 
-        it 'generates the expected facebook tag' do
-          expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" onclick=\"popUp=window.open(&#39;http://www.facebook.com/sharer.php?u=http://thisisbd.com?src=fb&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://www.facebook.com/\">Share on Facebook</a>")
+        context 'without a twitter handle' do
+          before :each do
+            @options = {
+              url: 'http://thisisbd.com',
+              twitter_message: 'This is BD - A creative agency in London'
+            }
+          end
+
+          it 'generates the expected twitter tag' do
+            expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" class=\"social_share_tw\" onclick=\"popUp=window.open(&#39;http://twitter.com/intent/tweet?text=This is BD - A creative agency in London http%3A%2F%2Fthisisbd.com%3Fsrc%3Dtw&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://twitter.com/\">Share on Twitter</a>")
+          end
         end
       end
 
       context 'with individual_settings set' do
-        before :each do
-          @options = {
-            individual_settings: true,
+        context 'with a twitter handle' do
+          before :each do
+            @options = {
+              individual_settings: true,
+
+              twitter: {
+                url: 'http://mattrayner.co.u/twitter_specific_page',
+                handle: '@mattrayner',
+                message: 'Matt Rayner - A full-stack Rubyist in London'
+              },
+
+              facebook: {
+                url: 'http://mattrayner.co.uk/facebook_specific_page'
+              }
+            }
+          end
 
-            twitter: {
-              url: 'http://mattrayner.co.u/twitter_specific_page',
-              handle: '@mattrayner',
-              message: 'Matt Rayner - A full-stack Rubyist in London'
-            },
+          it 'generates the expected facebook tag' do
+            expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" class=\"social_share_fb\" onclick=\"popUp=window.open(&#39;http://www.facebook.com/sharer.php?u=http%3A%2F%2Fmattrayner.co.uk%2Ffacebook_specific_page&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://www.facebook.com/\">Share on Facebook</a>")
+          end
 
-            facebook: {
-              url: 'http://mattrayner.co.uk/facebook_specific_page'
-            }
-          }
+          it 'generates the expected twitter tag' do
+            expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" class=\"social_share_tw\" onclick=\"popUp=window.open(&#39;http://twitter.com/intent/tweet?text=Matt Rayner - A full-stack Rubyist in London via @mattrayner http%3A%2F%2Fmattrayner.co.u%2Ftwitter_specific_page&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://twitter.com/\">Share on Twitter</a>")
+          end
         end
 
-        it 'generates the expected twitter tag' do
-          expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" onclick=\"popUp=window.open(&#39;http://www.facebook.com/sharer.php?u=http://mattrayner.co.uk/facebook_specific_page?src=fb&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://www.facebook.com/\">Share on Facebook</a>")
-        end
+        context 'without a twitter handle' do
+          before :each do
+            @options = {
+              individual_settings: true,
+
+              twitter: {
+                url: 'http://mattrayner.co.u/twitter_specific_page',
+                message: 'Matt Rayner - A full-stack Rubyist in London'
+              },
 
-        it 'generates the expected facebook tag' do
-          #expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" onclick=\"popUp=window.open(&#39;http://twitter.com/intent/tweet?text=Matt Rayner - A full-stack Rubyist in London via @mattrayner - http://mattrayner.co.u/twitter_specific_page?src=tw&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://twitter.com/\">Share on Twitter</a>")
+              facebook: {
+                url: 'http://mattrayner.co.uk/facebook_specific_page'
+              }
+            }
+          end
+
+          it 'generates the expected facebook tag' do
+            expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" class=\"social_share_fb\" onclick=\"popUp=window.open(&#39;http://www.facebook.com/sharer.php?u=http%3A%2F%2Fmattrayner.co.uk%2Ffacebook_specific_page&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://www.facebook.com/\">Share on Facebook</a>")
+          end
+
+          it 'generates the expected twitter tag' do
+            expect( social_share_tags(@options) ).to include("<a rel=\"nofollow\" class=\"social_share_tw\" onclick=\"popUp=window.open(&#39;http://twitter.com/intent/tweet?text=Matt Rayner - A full-stack Rubyist in London http%3A%2F%2Fmattrayner.co.u%2Ftwitter_specific_page&#39;,&#39;popupwindow&#39;,&#39;scrollbars=yes,width=800,height=400&#39;);popUp.focus();return false\" href=\"http://twitter.com/\">Share on Twitter</a>")
+          end
         end
       end
     end

data/spec/spec_helper.rb

@@ -3,6 +3,9 @@ $LOAD_PATH.unshift File.join(__FILE__, '../../lib')
 require 'bundler'
 Bundler.setup(:default, :test)
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'rails'
 require 'pry'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social_sharer
 version: !ruby/object:Gem::Version
-  version: 0.1.3.2
+  version: 0.1.4.pre.alpha.pre.15
 platform: ruby
 authors:
 - Matthew Rayner
@@ -14,126 +14,140 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.9.6
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7.6
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.2
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.34.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.34.2
 - !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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
 description: Adds a set of view methods that allow the users to create sharing buttons
@@ -144,10 +158,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .rubocop
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -157,6 +171,7 @@ files:
 - lib/social_sharer/version.rb
 - lib/social_sharer/view_helpers.rb
 - social_sharer.gemspec
+- social_sharer_logo.png
 - spec/lib/social_sharer_railtie_spec.rb
 - spec/lib/social_sharer_spec.rb
 - spec/lib/social_sharer_view_helpers_spec.rb
@@ -171,17 +186,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A set of view helpers that allow users to create social sharing buttons easily
@@ -190,4 +205,3 @@ test_files:
 - spec/lib/social_sharer_spec.rb
 - spec/lib/social_sharer_view_helpers_spec.rb
 - spec/spec_helper.rb
-has_rdoc: