acts_as_shareable_object 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c21369d78cf3c3aad83743d42a41f028eb093f6
+  data.tar.gz: 299b45c7aabe5602b88ae3e73b8add5c3c20cf83
+SHA512:
+  metadata.gz: 0281272e9ebe6a2a245d1dde37894e9a5890b5800dd5f2ccd87de01c437483438dcd13fe7063938621ac891f80a4b391c89760daa4019fe6dbd8c2b6d53c2064
+  data.tar.gz: 54d7d6b9afdc60312ea0f6949f599fda33cbcd2632ac2072fc893f3c319942c6f6b3ddfab2e1c4b4f38c82e27fcccb467363157a28f170e308ab80cb56f525c7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Jure Žove
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsShareableObject'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+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/acts_as_shareable_object.rb

@@ -0,0 +1,21 @@
+require "acts_as_shareable_object/active_record/acts/shareable_object"
+require "acts_as_shareable_object/action_view/shareable_object/view_helpers"
+
+module ActsAsShareableObject
+  if defined?(Rails::Railtie)
+    class Railtie < Rails::Railtie
+      initializer 'acts_as_shareable_object.include_in_active_record' do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send(:include, ActiveRecord::Acts::ShareableObject)
+        end
+      end
+
+      initializer 'acts_as_shareable_object.view_helpers' do
+        ActionView::Base.send(:include, ActionView::ShareableObject::ViewHelpers)
+      end
+    end
+  else
+    ActiveRecord::Base.send(:include, ActiveRecord::Acts::ShareableObject) if defined?(ActiveRecord)
+    ActionView::Base.send(:include, ActionView::ShareableObject::ViewHelpers) if defined?(ActionView)
+  end
+end

data/lib/acts_as_shareable_object/action_view/shareable_object/view_helpers.rb

@@ -0,0 +1,25 @@
+module ActionView
+  module ShareableObject
+    module ViewHelpers
+      def social_meta_tags_for(object, overrides = {})
+        raise "You need to add acts_as_shareable_object to your #{object.class} model." unless object.respond_to?(:social_meta_properties)
+        parse_tags(object.social_meta_properties).join("\n").html_safe
+      end
+
+      private
+
+      def parse_tags(properties, namespace = nil)
+        tags = []
+        Array(properties).each do |key, value|
+          if value.is_a?(Hash)
+            tags << parse_tags(value, [namespace, key].compact.join(':'))
+          else
+            name = [namespace, key].join(':')
+            tags << tag(:meta, {name: name, property: name, content: value}, true)
+          end
+        end
+        tags
+      end
+    end
+  end
+end

data/lib/acts_as_shareable_object/active_record/acts/shareable_object.rb

@@ -0,0 +1,47 @@
+require 'acts_as_shareable_object/active_record/acts/shareable_object/default_properties'
+
+module ActiveRecord
+  module Acts
+    module ShareableObject
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_shareable_object(options = {})
+          cattr_accessor :shareable_options
+          self.shareable_options = [options].flatten
+          # delegate :url_helpers, to: 'Rails.application.routes'
+
+          include InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+        def social_meta_properties
+          properties = values_for(ActiveRecord::Acts::ShareableObject::DefaultProperties.all)
+          properties.merge! values_for(shareable_options) unless shareable_options.nil?
+          properties
+        end
+
+        private
+
+        def values_for(properties, namespace = nil)
+          values = {}
+          Array(properties).each do |property|
+            if property.is_a?(Hash)
+              property.map do |k, v|
+                method = [namespace, k].compact.join("_")
+                values[k] = respond_to?(method) ? send(method) : values_for(v, method)
+              end
+            else
+              method = [namespace, property].compact.join("_")
+              values[property] = send(method) if respond_to?(method)
+            end
+          end
+          values.reject{ |k, v| v.empty? }
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_shareable_object/active_record/acts/shareable_object/default_properties.rb

@@ -0,0 +1,79 @@
+module ActiveRecord
+  module Acts
+    module ShareableObject
+      module DefaultProperties
+        TWITTER = [
+            twitter: [
+              :card,
+              :title,
+              :description,
+              :url,
+              :image0,
+              :image1,
+              :image2,
+              :image3,
+              :data1,
+              :label1,
+              :data2,
+              :label2,
+              image: [
+                :src,
+                :width,
+                :height
+              ],
+              player: [
+                :width,
+                :height,
+                :stream
+              ],
+              site: [:id],
+              creator: [:id],
+              app: [
+                name: [
+                  :iphone,
+                  :ipad,
+                  :googleplay
+                ],
+                id: [
+                  :iphone,
+                  :ipad,
+                  :googleplay 
+                ],
+                url: [
+                  :iphone,
+                  :ipad,
+                  :googleplay
+                ]
+              ]
+            ]
+          ]
+
+          OPEN_GRAPH = [
+            og: [
+              :title,
+              :site_name,
+              :url,
+              :description,
+              :image,
+              :type
+            ],
+            article: [
+              :author,
+              :publisher
+            ]
+          ]
+
+          FACEBOOK = [
+            fb: [
+              :app_id,
+              :admin
+            ]
+          ]
+
+          def self.all
+            TWITTER | OPEN_GRAPH | FACEBOOK
+          end
+      end
+    end
+  end
+end

data/lib/acts_as_shareable_object/version.rb

@@ -0,0 +1,3 @@
+module ActsAsShareableObject
+  VERSION = "0.0.1"
+end

data/lib/tasks/acts_as_shareable_object_tasks.rake

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

data/test/acts_as_shareable_object_test.rb

@@ -0,0 +1,105 @@
+require 'test_helper'
+
+class ActsAsShareableObjectTest < ActiveSupport::TestCase
+  fixtures :cars
+
+  test "truth" do
+    assert_kind_of Module, ActsAsShareableObject
+  end
+
+  test "twitter summary card type" do
+    car = cars(:pagani)
+
+    car.stubs(:twitter_card).returns("summary")
+
+    assert_equal car.social_meta_properties[:twitter][:card], "summary"
+  end
+
+  test "twitter summary card image" do
+    car = cars(:pagani)
+
+    car.stubs(:twitter_image).returns(car.image)
+
+    assert_equal car.social_meta_properties[:twitter][:image], car.image
+  end
+
+  test "twitter card site" do
+    car = cars(:pagani)
+
+    car.stubs(:twitter_site).returns(car.company_twitter_handle)
+
+    assert_equal car.social_meta_properties[:twitter][:site], car.company_twitter_handle
+  end
+
+  test "twitter photo card image src" do
+    car = cars(:pagani)
+
+    car.stubs(:twitter_image_src).returns(car.image)
+
+    assert_equal car.social_meta_properties[:twitter][:image][:src], car.image
+
+  end
+
+  test "twitter photo card image details" do
+    car = cars(:pagani)
+
+    car.stubs(:twitter_image_src).returns(car.image)
+    car.stubs(:twitter_image_width).returns("812")
+    car.stubs(:twitter_image_height).returns("475")
+
+    assert_equal car.social_meta_properties[:twitter][:image][:src], car.image
+    assert_equal car.social_meta_properties[:twitter][:image][:width], car.twitter_image_width
+    assert_equal car.social_meta_properties[:twitter][:image][:height], car.twitter_image_height
+  end
+
+  test "single custom tag" do
+    car = cars(:pagani)
+
+    class << car
+      acts_as_shareable_object :og_test
+    end
+
+    car.stubs(:og_test).returns("test tag, YO")
+
+    assert_equal car.social_meta_properties[:og_test], car.og_test
+  end
+
+  test "single nested custom tag" do
+    car = cars(:pagani)
+
+    class << car
+      acts_as_shareable_object og: :nested
+    end
+
+    car.stubs(:og_nested).returns("this is nested")
+
+    assert_equal car.social_meta_properties[:og][:nested], car.og_nested
+  end
+
+  test "single nested array custom tag" do
+    car = cars(:pagani)
+
+    class << car
+      acts_as_shareable_object og: [:nested]
+    end
+
+    car.stubs(:og_nested).returns("this is nested")
+
+    assert_equal car.social_meta_properties[:og][:nested], car.og_nested
+  end
+
+  test "multiple custom shareable tags" do
+    car = cars(:pagani)
+
+    class << car
+      acts_as_shareable_object og: [:custom_property, nested: [:egg]]
+    end
+
+    car.stubs(:og_custom_property).returns("og custom property")
+    car.stubs(:og_nested_egg).returns("nested egg")
+
+    assert_equal car.social_meta_properties[:og][:custom_property], car.og_custom_property
+    assert_equal car.social_meta_properties[:og][:nested][:egg], car.og_nested_egg
+  end
+
+end

data/test/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/test/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__)
+
+Rails.application.load_tasks

data/test/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 any plugin's vendor/assets/javascripts directory 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/test/dummy/app/assets/javascripts/cars.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,15 @@
+/*
+ * 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 any plugin's vendor/assets/stylesheets directory 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/assets/stylesheets/cars.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/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