tbg_social 0.1.1

data/fixtures/vcr_cassettes/twitter_engagement_count.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://urls.api.twitter.com/1/urls/count.json?url=http://www.studentbeans.com/student101/a/relationships/university-sex-league-6793.html
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - must-revalidate, max-age=900
+      Content-Type:
+      - application/json;charset=utf-8
+      Expires:
+      - Wed, 28 May 2014 15:50:03 GMT
+      Last-Modified:
+      - Wed, 28 May 2014 15:35:03 GMT
+      Server:
+      - tfe
+      Content-Length:
+      - '127'
+      Accept-Ranges:
+      - bytes
+      Date:
+      - Wed, 28 May 2014 15:35:03 GMT
+      Via:
+      - 1.1 varnish
+      Age:
+      - '0'
+      Connection:
+      - keep-alive
+      X-Served-By:
+      - cache-tw-lon2-cr1-2-TWLON2
+      X-Cache:
+      - MISS
+      X-Cache-Hits:
+      - '0'
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"count":310,"url":"http:\/\/www.studentbeans.com\/student101\/a\/relationships\/university-sex-league-6793.html\/"}'
+    http_version: 
+  recorded_at: Wed, 28 May 2014 15:35:03 GMT
+recorded_with: VCR 2.9.0

data/lib/generators/social/install_generator.rb

@@ -0,0 +1,18 @@
+module Social
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Creates a SocialEngagement model and db table'
+
+    def create_social_engagement
+      generate "model", "SocialEngagement facebook:integer twitter:integer url:string:uniq created_at:datetime updated_at:datetime --no-test-framework"
+    end
+
+    def migrate
+      rake "db:migrate"
+      rake "db:migrate RAILS_ENV=test"
+    end
+
+    def require_url_in_initializer
+      initializer "social_engagement.rb", "require 'social/url'"
+    end
+  end
+end

data/lib/social.rb

@@ -0,0 +1,11 @@
+require 'social/engagement'
+require 'social/engageable'
+require 'social/facebook'
+require 'social/twitter'
+require 'social/google_plus'
+require 'social/invalidation_policy'
+require "social/engine"
+require "social/model"
+
+module Social
+end

data/lib/social/engageable.rb

@@ -0,0 +1,5 @@
+module Social::Engageable
+  def social_engagement
+    Social::Engagement.for(self)
+  end
+end

data/lib/social/engagement.rb

@@ -0,0 +1,38 @@
+module Social
+  class Engagement
+
+    def self.for(model_instance)
+      url = Url.for(model_instance)
+      for_url(url)
+    end
+
+    def self.for_url(url)
+      begin
+        try_to_get_from_cache(url)
+      rescue ActiveRecord::RecordNotFound
+        social_engagement_from_web = from_web(url)
+        social_engagement_from_web.save
+        social_engagement_from_web
+      end
+    end
+
+    def self.from_web(url)
+      facebook = Facebook.total_count(url)
+      twitter = Twitter.total_count(url)
+      SocialEngagement.new(url: url, facebook: facebook, twitter: twitter)
+    end
+
+    private
+
+    def self.try_to_get_from_cache(url)
+      cached_social_engagement = SocialEngagement.for_url(url)
+      if InvalidationPolicy.valid?(cached_social_engagement)
+        cached_social_engagement
+      else
+        social_engagement_from_web = from_web(url)
+        cached_social_engagement.update_counts(social_engagement_from_web)
+        cached_social_engagement
+      end
+    end
+  end
+end

data/lib/social/engine.rb

@@ -0,0 +1,5 @@
+module Social
+  class Engine < ::Rails::Engine
+    isolate_namespace Social
+  end
+end

data/lib/social/facebook.rb

@@ -0,0 +1,30 @@
+module Social
+  class Facebook
+    ENDPOINT = 'http://graph.facebook.com/?id=URL'
+    COUNT_KEY = 'shares'
+
+    def self.total_count(url)
+      begin
+        response = Net::HTTP.get(URI(ENDPOINT.gsub('URL', url)))
+        json = JSON.parse(response)
+        if json.has_key?(COUNT_KEY)
+          json[COUNT_KEY]
+        else
+          log_and_return_zero(url, response)
+        end
+      rescue StandardError => e
+        log_and_return_zero(url, nil, e)
+      end
+    end
+
+    private
+
+    def self.log_and_return_zero(url, response = nil, exception = nil)
+      log_message = "Could not get facebook engagement for url: #{url}\n"
+      log_message << "Response: #{response}\n" if response.present?
+      log_message << "Exception: #{exception.message}\n" if exception.present?
+      Rails.logger.warn(log_message)
+      0
+    end
+  end
+end

data/lib/social/google_plus.rb

@@ -0,0 +1,34 @@
+module Social
+  class GooglePlus
+    ENDPOINT = 'https://plus.google.com/ripple/details?url=URL'
+    REGEX = /(\d)* public shares/
+
+    def self.total_count(url)
+      begin
+        response = Net::HTTP.get(URI(ENDPOINT.gsub('URL', url)))
+        matches = REGEX.match(response)
+        if matches
+          begin
+            Integer(matches[1])
+          rescue ArgumentError
+            log_and_return_zero(url, response)
+          end
+        else
+          log_and_return_zero(url, response)
+        end
+      rescue StandardError => e
+        log_and_return_zero(url, nil, e)
+      end
+    end
+
+    private
+
+    def self.log_and_return_zero(url, response = nil, exception = nil)
+      log_message = "Could not get Google Plus engagement for url: #{url}\n"
+      log_message << "Response: #{response}\n" if response.present?
+      log_message << "Exception: #{exception.message}\n" if exception.present?
+      Rails.logger.warn(log_message)
+      0
+    end
+  end
+end

data/lib/social/invalidation_policy.rb

@@ -0,0 +1,7 @@
+module Social
+  class InvalidationPolicy
+    def self.valid?(social_engagement)
+      social_engagement.updated_at > 4.hours.ago
+    end
+  end
+end

data/lib/social/model.rb

@@ -0,0 +1,26 @@
+module Social
+  module Model
+    def self.included(base)
+      base.validates :url, presence: true
+
+      base.include InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+      def update_counts(social_engagement)
+        unless social_engagement.facebook == facebook && social_engagement.twitter == twitter
+          update(facebook: social_engagement.facebook, twitter: social_engagement.twitter)
+        else
+          touch
+        end
+      end
+    end
+
+    module ClassMethods
+      def for_url(url)
+        find_by_url!(url)
+      end
+    end
+  end
+end

data/lib/social/twitter.rb

@@ -0,0 +1,30 @@
+module Social
+  class Twitter
+    ENDPOINT = 'http://urls.api.twitter.com/1/urls/count.json?url=URL'
+    COUNT_KEY = 'count'
+
+    def self.total_count(url)
+      begin
+        response = Net::HTTP.get(URI(ENDPOINT.gsub('URL', url)))
+        json = JSON.parse(response)
+        if json.has_key?(COUNT_KEY)
+          json[COUNT_KEY]
+        else
+          log_and_return_zero(url, response)
+        end
+      rescue StandardError => e
+        log_and_return_zero(url, nil, e)
+      end
+    end
+
+    private
+
+    def self.log_and_return_zero(url, response = nil, exception = nil)
+      log_message = "Could not get twitter engagement for url: #{url}\n"
+      log_message << "Response: #{response}\n" if response.present?
+      log_message << "Exception: #{exception.message}\n" if exception.present?
+      Rails.logger.warn(log_message)
+      0
+    end
+  end
+end

data/lib/social/url.rb

@@ -0,0 +1,10 @@
+module Social
+  class Url
+    include Singleton
+    include Rails.application.routes.url_helpers
+
+    def self.for(model_instance)
+      Url.instance.url_for(model_instance)
+    end
+  end
+end

data/lib/social/version.rb

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

data/lib/tasks/social_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :social do
+#   # Task goes here
+# end

data/social.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require 'social/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tbg_social"
+  spec.version       = Social::VERSION
+  spec.authors       = ["zduci"]
+  spec.email         = ["ra.busuioc@gmail.com"]
+  spec.summary       = %q{Social engagement module}
+  spec.description   = %q{It finds, caches and updates social engagement of urls on social media (facebook, twitter)}
+  spec.homepage      = "https://github.com/thebeansgroup/social"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency "rails", ">= 3.2.13"
+  #spec.add_dependency "activeresource", "~> 4.0"
+  #spec.add_dependency "activeresource"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'pry-rails'
+  spec.add_development_dependency 'pry-stack_explorer'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "webmock"
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

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

data/spec/dummy/app/models/offer.rb

@@ -0,0 +1,2 @@
+class Offer < ActiveRecord::Base
+end

data/spec/dummy/app/models/social_engagement.rb

@@ -0,0 +1,3 @@
+class SocialEngagement < ActiveRecord::Base
+  include Social::Model
+end