social_butterfly 0.0.2 → 0.0.3

data/README.rdoc

@@ -0,0 +1,103 @@
+= social_butterfly
+{<img src="https://secure.travis-ci.org/kevinelliott/social_butterfly.png">}[http://travis-ci.org/kevinelliott/social_butterfly]
+
+Share and track site content with social networks, for Ruby. ActionController/ActionView integration coming soon.
+
+== About
+
+There are a significant number of gems and snippets out there that enable some kind of social integration for your Ruby or Rails app, but they are typically overly complicated and tend to focus on authentication/authorization more than offering useful integrations with the social networks. Interacting with the social networks often ends up requiring custom code to query a remote graph and then process returned JSON responses. This approach is fine for scenarios where custom solutions are required.
+
+But if you just want to snap on the ability to share some content on social networks and then track how well they are performing, that's where social_butterfly makes things easy. This library for Ruby exposes a simple API for interacting with various social networks, such as Facebook and Twitter, without requiring extensive custom code to integrate them into your applications.
+
+This is not an authentication or authorization gem. It is focused on helping you add features to your site that will help to promote site content.
+
+== Project Status
+
+=== In development.
+
+The architecture and feature set is still being determined, though the gem is currently useful in limited capacities.
+
+If you'd like to jump in and help out, please contact me and we can discuss. Otherwise, please do submit pull requests for bug fixes and minor feature enhancements.
+
+== Installation
+
+  gem install social_butterfly
+  
+If you're going to use this with Rails or some other Ruby-based web framework, be sure to add the gem to your Gemfile and run bundle install.
+
+== Example Implementations
+
+The following sites have integrated this library and can give you an idea of how this library can be used.
+
+{Vino Locale Wine Bar detail page at WineTribe}[http://winetribeapp.com/wine_bars/vino-locale-palo-alto/]
+
+== How To Integrate
+
+=== Generate share URLs from a Model instance for attaching to buttons/links for Facebook, Google+ and Twitter
+
+  >> book = Book.find_by_name('Goldilocks and the Three Bears')
+  >> content = { :url => polymorphic_url(book) }
+  >> SocialButterfly::Services::FacebookService.share_button_url(content)
+  => 'https://www.facebook.com/sharer/sharer.php?u=http://mysite.dev/books/4'
+
+  >> SocialButterfly::Services::GooglePlusService.share_button_url(content)
+  => 'https://plus.google.com/share?url=http://mysite.dev/books/4'
+
+  >> options = { :via => 'kevinelliott' }
+  >> SocialButterfly::Services::TwitterService.share_button_url(content, options)
+  => 'http://twitter.com/share?url=http://mysite.dev/books/4&text=Check%20this%20out%20--%20&via=kevinelliott&count=none'
+  
+=== Get Facebook share count for URL
+
+  >> content = { :url => 'http://winetribeapp.com/' }
+  => {:url=>"http://winetribeapp.com/"}
+  >> SocialButterfly::Services::FacebookService.track(content)
+  => {:shares=>2}
+  
+=== Get Google+ share count for URL
+
+  >> SocialButterfly::Services::GooglePlusService.track(content)
+  => {:shares=>1}
+  
+=== Get Twitter share count for URL
+
+  >> SocialButterfly::Services::TwitterService.track(content)
+  => {:shares=>3}
+  
+=== Get share counts for all known services
+
+  >> SocialButterfly::Services.track(content)
+  => {:facebook=>{:shares=>2}, :google_plus=>{:shares=>1}, :twitter=>{:shares=>3}}
+  
+
+== Maintainer
+
+* Kevin Elliott - http://kevinelliott.net - http://github.com/kevinelliott
+* WeLike - http://www.welikeinc.com - http://github.com/welike
+
+== Contributors
+
+No one else has contributed yet, but they'll be acknowledged here once they do.
+
+== License
+
+(The MIT License)
+
+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/app/views/social_butterfly/_share_links.html.erb

@@ -0,0 +1,11 @@
+<%= link_to( image_tag('social-facebook.png')+"Share on Facebook",
+             facebook_share_button_url( { :url => polymorphic_url(item) } ) 
+           ) %>
+<span class="spacer">|</span>
+<%= link_to( image_tag('social-twitter.png')+'Tweet It',
+             twitter_share_button_url( { :url => polymorphic_url(item) } ) 
+           ) %>
+<span class="spacer">|</span>
+<%= link_to( image_tag( 'social-gplus.png')+'Share on Google+',
+             google_plus_share_button_url( { :url => polymorphic_url(item) } ) 
+           ) %>

data/lib/social_butterfly.rb

@@ -1,5 +1,63 @@
-require "social_butterfly/version"
-require "social_butterfly/services"
-
 module SocialButterfly
+  def self.frameworks
+    frameworks = []
+    case
+      when rails?   then frameworks << 'rails'
+    end
+    frameworks
+  end
+
+  def self.load_framework!
+    show_warning if frameworks.empty?
+    frameworks.each do |framework|
+      begin
+        require framework
+      rescue NameError => e
+        raise "Failed to load framework #{framework.inspect}. Have you added it to Gemfile?"
+      end
+    end
+  end
+  
+  def self.show_warning
+      $stderr.puts <<-EOC
+  warning: no framework detected.
+  would you check out if your Gemfile appropriately configured?
+  ---- e.g. ----
+  when Rails:
+      gem 'rails'
+      gem 'social_butterfly'
+
+      EOC
+  end
+  
+  def self.load_social_butterfly!
+    require 'social_butterfly/version'
+    require 'social_butterfly/services'
+    require 'social_butterfly/helpers/social_butterfly_helper'
+  end
+  
+  def self.hook!
+    load_framework!
+    load_social_butterfly!
+    require 'social_butterfly/hooks'
+    if rails?
+      require 'social_butterfly/rails/action_view_extension'
+      require 'social_butterfly/rails/railtie'
+      require 'social_butterfly/rails/engine'
+    else
+      SocialButterfly::Hooks.init!
+    end
+  end
+  
+  def self.load!
+    hook!
+  end
+  
+  private
+  
+  def self.rails?
+    defined?(::Rails)
+  end
 end
+
+SocialButterfly.load!

data/lib/social_butterfly/helpers/social_butterfly_helper.rb

@@ -0,0 +1,2 @@
+module SocialButterflyHelper
+end

data/lib/social_butterfly/hooks.rb

@@ -0,0 +1,9 @@
+module SocialButterfly
+  class Hooks
+    def self.init!
+      ActiveSupport.on_load(:action_view) do
+        ::ActionView::Base.send :include, SocialButterfly::Rails::ActionViewExtension
+      end
+    end
+  end
+end

data/lib/social_butterfly/rails.rb

@@ -0,0 +1,7 @@
+require "social_butterfly/rails/acts_as_social_butterfly"
+require "social_butterfly/rails/engine"
+
+module SocialButterfly
+  module Rails
+  end
+end

data/lib/social_butterfly/rails/action_view_extension.rb

@@ -0,0 +1,23 @@
+module SocialButterfly
+  module Rails
+    module ActionViewExtension
+      def facebook_share_button_url(content={}, options={})
+        content = { :text => '' }.merge(content)
+        options = { }.merge(options)
+        SocialButterfly::Services::FacebookService.share_button_url(content, options)
+      end
+
+      def google_plus_share_button_url(content={}, options={})
+        content = { :text => '' }.merge(content)
+        options = { }.merge(options)
+        SocialButterfly::Services::GooglePlusService.share_button_url(content, options)
+      end
+
+      def twitter_share_button_url(content={}, options={})
+        content = { :text => 'Check this out -- ' }.merge(content)
+        options = { :via => '' }.merge(options)
+        SocialButterfly::Services::TwitterService.share_button_url(content, options)
+      end
+    end
+  end
+end

data/lib/social_butterfly/rails/acts_as_social_butterfly.rb

@@ -0,0 +1,9 @@
+module SocialButterfly::Rails::ActsAsSocialButterfly
+  def acts_as_social_butterfly
+    include InstanceMethods
+  end
+
+  module InstanceMethods
+  end
+end
+ActiveRecord::Base.extend SocialButterfly::Rails::ActsAsSocialButterfly

data/lib/social_butterfly/rails/engine.rb

@@ -0,0 +1,15 @@
+require "social_butterfly"
+require "social_butterfly/rails"
+require "rails"
+
+module SocialButterfly
+  class Engine < ::Rails::Engine
+    initializer 'social_butterfly.ar_extensions', :before=>"action_controller.deprecated_routes" do |app|
+      ActiveRecord::Base.extend SocialButterfly::Rails::ActsAsSocialButterfly
+    end
+    
+    config.to_prepare do
+      ActionView::Base.send(:include, SocialButterflyHelper)
+    end
+  end
+end

data/lib/social_butterfly/rails/railtie.rb

@@ -0,0 +1,9 @@
+module SocialButterfly
+  module Rails
+    class Railtie < ::Rails::Railtie #:nodoc:
+      initializer 'social_butterfly' do |app|
+        SocialButterfly::Hooks.init!
+      end
+    end
+  end
+end

data/lib/social_butterfly/services.rb

@@ -4,6 +4,12 @@ require 'social_butterfly/services/twitter_service'
 
 module SocialButterfly
   module Services
+    VALID_SERVICES = [
+      :facebook,
+      :google_plus,
+      :twitter
+    ]
+    
     def self.track(content, options={})
       results = {}
       results[:facebook]    = SocialButterfly::Services::FacebookService.track(content, options)

data/lib/social_butterfly/version.rb

@@ -1,3 +1,3 @@
 module SocialButterfly
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/social_butterfly.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Kevin Elliott"]
   s.email       = ["kevin@welikeinc.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/kevinelliott/social_butterfly"
   s.summary     = %q{Now your content can be as popular as Cher in Clueless}
   s.description = %q{Share and track content on social networks in Ruby.}
 
@@ -17,9 +17,15 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.extra_rdoc_files = ['README.rdoc']
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.licenses = ['MIT']
+
+  %w{ activesupport actionpack railties }.each do |gem|
+    s.add_dependency gem, ['>= 3.0.0']
+  end
+  %w{ activerecord activemodel }.each do |gem|
+    s.add_development_dependency gem, ['>= 3.0.0']
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: social_butterfly
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,28 +10,93 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-01-04 00:00:00.000000000Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70165147292260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165147292260
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70165147291180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165147291180
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70165147290680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165147290680
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70165147289900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70165147289900
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70165147289220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70165147289220
 description: Share and track content on social networks in Ruby.
 email:
 - kevin@welikeinc.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.rdoc
 files:
 - .gitignore
 - Gemfile
-- README
+- README.rdoc
 - Rakefile
+- app/views/social_butterfly/_share_links.html.erb
 - lib/social_butterfly.rb
 - lib/social_butterfly/abstract_service.rb
+- lib/social_butterfly/helpers/social_butterfly_helper.rb
+- lib/social_butterfly/hooks.rb
+- lib/social_butterfly/rails.rb
+- lib/social_butterfly/rails/action_view_extension.rb
+- lib/social_butterfly/rails/acts_as_social_butterfly.rb
+- lib/social_butterfly/rails/engine.rb
+- lib/social_butterfly/rails/railtie.rb
 - lib/social_butterfly/services.rb
 - lib/social_butterfly/services/facebook_service.rb
 - lib/social_butterfly/services/google_plus_service.rb
 - lib/social_butterfly/services/twitter_service.rb
 - lib/social_butterfly/version.rb
 - social_butterfly.gemspec
-homepage: ''
-licenses: []
+homepage: https://github.com/kevinelliott/social_butterfly
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:

data/README

@@ -1 +0,0 @@
-# social_butterfly