cartoonist-twitter 0.0.9

data/.gitignore

@@ -0,0 +1,2 @@
+*~
+/cartoonist-twitter*.gem

data/app/controllers/admin/tweets_controller.rb

@@ -0,0 +1,38 @@
+class Admin::TweetsController < CartoonistController
+  before_filter :ensure_ssl!
+  before_filter :check_admin!
+
+  def index
+    @untweeted = Tweet.untweeted.created_chronological.not_disabled
+    @tweeted = Tweet.tweeted.reverse_chronological
+  end
+
+  def edit
+    @tweet = Tweet.find params[:id].to_i
+  end
+
+  def update
+    @tweet = Tweet.update_tweet params
+    send_tweet_if_requested
+    tweet_or_entity_redirect
+  end
+
+  def create
+    @tweet = Tweet.create_tweet params
+    send_tweet_if_requested
+    tweet_or_entity_redirect
+  end
+
+  private
+  def send_tweet_if_requested
+    @tweet.manual_tweet! if params[:tweet_now].present?
+  end
+
+  def tweet_or_entity_redirect
+    if params[:destination] == "entity_edit" && @tweet.entity.entity_edit_url
+      redirect_to @tweet.entity.entity_edit_url
+    else
+      redirect_to "/admin/tweets/#{@tweet.id}/edit"
+    end
+  end
+end

data/app/models/tweet.rb

@@ -0,0 +1,214 @@
+class Tweet < ActiveRecord::Base
+  validate :doesnt_update_tweet_after_tweeted
+  validate :entity_doesnt_change, :on => :update
+  attr_accessible :entity_id, :entity_type, :tweet, :tweeted_at
+
+  def allow_tweet_now?
+    if entity.kind_of? Postable
+      posted = entity.posted?
+    else
+      posted = true
+    end
+
+    allow_save? && !disabled? && posted
+  end
+
+  def allow_save?
+    !tweeted?
+  end
+
+  def disabled?
+    tweet_style == :disabled
+  end
+
+  def entity
+    @entity ||= Cartoonist::Entity[entity_type.to_sym].find(entity_id)
+  end
+
+  def description
+    "#{entity.entity_localized_label}: #{entity.entity_description}"
+  end
+
+  def formatted_tweeted_at(default_msg = "not yet tweeted")
+    return default_msg unless tweeted_at
+    tweeted_at.localtime.strftime "%-m/%-d/%Y at %-l:%M %P"
+  end
+
+  def manual_tweet!
+    raise "Tweeting is not allowed!" unless allow_tweet_now?
+    return if tweeted?
+    return if disabled?
+    send_tweet!
+  end
+
+  def auto_tweet!
+    return if tweeted?
+    return unless expected_tweet_time
+    return unless Time.now >= expected_tweet_time
+    send_tweet!
+  end
+
+  def tweet_style
+    Setting[:"#{entity.entity_type}_tweet_style"]
+  end
+
+  def tweet_time
+    Setting[:"#{entity.entity_type}_tweet_time"]
+  end
+
+  def form_path
+    if new_record?
+      "/admin/tweets"
+    else
+      "/admin/tweets/#{id}"
+    end
+  end
+
+  def form_method
+    if new_record?
+      :post
+    else
+      :put
+    end
+  end
+
+  def expected_tweet_time
+    case tweet_style
+    when :disabled
+      nil
+    when :manual
+      nil
+    when :automatic
+      entity.posted_at
+    when :automatic_timed
+      if tweet_time.blank?
+        entity.posted_at
+      elsif entity.posted_at
+        parsed = DateTime.strptime("#{entity.posted_at.year}-#{entity.posted_at.month}-#{entity.posted_at.day} #{tweet_time.downcase}", "%Y-%m-%d %I:%M %p").to_time
+        result = Time.local entity.posted_at.year, entity.posted_at.month, entity.posted_at.day, parsed.hour, parsed.min
+        result = result + 1.day if result < entity.posted_at.to_time
+        result
+      end
+    else
+      raise "Invalid tweet style #{tweet_style}"
+    end
+  end
+
+  def tweeted?
+    tweeted_at.present?
+  end
+
+  private
+  def send_tweet!
+    if Rails.env.production?
+      Twitter.update tweet
+    else
+      logger.info "Fake Tweet: #{tweet}"
+    end
+
+    self.tweeted_at = Time.now
+    save!
+  end
+
+  def doesnt_update_tweet_after_tweeted
+    if !tweeted_at_was.nil? && tweet_changed?
+      errors.add :tweet, "can't change after the tweet has been sent"
+    end
+  end
+
+  def entity_doesnt_change
+    if entity_id_changed?
+      errors.add :entity_id, "can't change"
+    end
+
+    if entity_type_changed?
+      errors.add :entity_id, "can't change"
+    end
+  end
+
+  class << self
+    def update_tweet(params)
+      tweet = find params[:id].to_i
+      raise "Saving is not allowed!" unless tweet.allow_save?
+      tweet.tweet = params[:tweet]
+      tweet.save!
+      tweet
+    end
+
+    def create_tweet(params)
+      raise "The entity_id is required!" if params[:entity_id].blank?
+      raise "The entity_type is required!" if params[:entity_type].blank?
+      create :entity_id => params[:entity_id].to_i, :entity_type => params[:entity_type], :tweet => params[:tweet]
+    end
+
+    def tweet_for(entity)
+      result = find_for entity
+
+      if result
+        result
+      else
+        new options_for(entity)
+      end
+    end
+
+    def create_for(entity)
+      create options_for(entity)
+    end
+
+    def options_for(entity)
+      { :entity_id => entity.id, :entity_type => entity.entity_type, :tweet => SimpleTemplate[Setting[:"#{entity.entity_type}_default_tweet"], :self => entity] }
+    end
+
+    def find_for(entity)
+      raise "Can only find tweets for entities!" unless entity.kind_of? Entity
+      where({ :entity_id => entity.id, :entity_type => entity.entity_type }).first
+    end
+
+    def tweeted
+      where "tweeted_at IS NOT NULL"
+    end
+
+    def untweeted
+      where "tweeted_at IS NULL"
+    end
+
+    def chronological
+      order "tweeted_at ASC"
+    end
+
+    def reverse_chronological
+      order "tweeted_at DESC"
+    end
+
+    def created_chronological
+      order "created_at ASC"
+    end
+
+    def created_reverse_chronological
+      order "created_at DESC"
+    end
+
+    def not_disabled
+      result = all
+
+      types = result.map(&:entity_type).uniq.select do |t|
+        Setting[:"#{t}_tweet_style"] != :disabled
+      end
+
+      result.select { |x| types.include? x.entity_type }
+    end
+
+    def styles(entity)
+      results = []
+      results << { :value => :disabled, :label => "tweet.style.disabled" }
+      results << { :value => :manual, :label => "tweet.style.manual" }
+
+      if Cartoonist::Entity[entity].include? Postable
+        results << { :value => :automatic, :label => "tweet.style.automatic" }
+        results << { :value => :automatic_timed, :label => "tweet.style.automatic_timed" }
+      end
+
+      results
+    end
+  end
+end

data/app/views/admin/tweets/_entity_tweet.html.erb

@@ -0,0 +1,22 @@
+<% tweet = Tweet.tweet_for entity %>
+<% if tweet.tweet_style != :disabled %>
+  <% destination = :entity_edit if destination.nil? %>
+  <%= form_tag tweet.form_path, :method => tweet.form_method do %>
+    <input type="hidden" name="entity_id" value="<%= tweet.entity_id %>" />
+    <input type="hidden" name="entity_type" value="<%= tweet.entity_type %>" />
+    <input type="hidden" name="destination" value="<%= destination %>" />
+
+    <p>
+      <%= t "admin.tweets.entity_tweet.tweet" %><br />
+      <textarea name="tweet" rows="2" cols="100" <%= 'disabled="disabled"'.html_safe unless tweet.allow_save? %>><%= tweet.tweet %></textarea>
+    </p>
+
+    <p>
+      <input type="submit" name="save" value="<%= t "admin.tweets.entity_tweet.save" %>" <%= 'disabled="disabled"'.html_safe unless tweet.allow_save? %> />
+    </p>
+
+    <p>
+      <input type="submit" name="tweet_now" value="<%= t "admin.tweets.entity_tweet.tweet_now" %>" <%= 'disabled="disabled"'.html_safe unless tweet.allow_tweet_now? %> />
+    </p>
+  <% end %>
+<% end %>

data/app/views/admin/tweets/edit.html.erb

@@ -0,0 +1,5 @@
+<p>
+  <%= @tweet.description %>
+</p>
+
+<%= render :partial => "admin/tweets/entity_tweet", :locals => { :entity => @tweet.entity, :destination => :tweet } %>

data/app/views/admin/tweets/index.html.erb

@@ -0,0 +1,21 @@
+<h2><%= t "admin.tweets.index.not_tweeted" %></h2>
+
+<ul>
+  <% @untweeted.each do |tweet| %>
+    <li>
+      <%= tweet.formatted_tweeted_at "" %>
+      <a href="/admin/tweets/<%= tweet.id %>/edit"><%= tweet.description %></a>
+    </li>
+  <% end %>
+</ul>
+
+<h2><%= t "admin.tweets.index.tweeted" %></h2>
+
+<ul>
+  <% @tweeted.each do |tweet| %>
+    <li>
+      <%= tweet.formatted_tweeted_at "" %>
+      <a href="/admin/tweets/<%= tweet.id %>/edit"><%= tweet.description %></a>
+    </li>
+  <% end %>
+</ul>

data/app/views/layouts/admin/tweets.html.erb

@@ -0,0 +1,3 @@
+<% content_for :page_title, t("admin.tweets.layout.section") %>
+<% content_for(:content) { yield } %>
+<%= render :template => "layouts/admin" %>

data/cartoonist-twitter.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  raise "Cannot find version file!" unless File.exists?(File.join(File.dirname(__FILE__), "../CARTOONIST_VERSION"))
+  cartoonist_version = File.read(File.join(File.dirname(__FILE__), "../CARTOONIST_VERSION")).strip
+  s.name          = "cartoonist-twitter"
+  s.version       = cartoonist_version
+  s.date          = Time.now.strftime "%Y-%m-%d"
+  s.summary       = "Cartoonist Twitter"
+  s.description   = "Plugin to allow tweeting of cartoonist entities."
+  s.authors       = ["Mike Virata-Stone"]
+  s.email         = "reasonnumber@gmail.com"
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.homepage      = "http://reasonnumber.com/cartoonist"
+  s.add_dependency "cartoonist", cartoonist_version
+  s.add_dependency "twitter", "~> 2.2.0"
+end

data/config/locales/en.yml

@@ -0,0 +1,43 @@
+en:
+  admin:
+    layout:
+      tab:
+        tweets: Tweets
+    tweets:
+      entity_tweet:
+        save: Save
+        tweet: "Tweet:"
+        tweet_now: Tweet Now
+      index:
+        not_tweeted: Not yet tweeted
+        tweeted: Tweeted
+      layout:
+        section: Tweets
+  cartoonist:
+    layout:
+      navigation:
+        follow_on_twitter: Follow us on Twitter
+        follow_on_twitter_title: Follow us on Twitter
+  settings:
+    show:
+      errors:
+        invalid_tweet_time: "Invalid tweet time '%{value}' should be formatted like: '1:22 pm' or '11:30 am'"
+      sections:
+        social_and_analytics:
+          twitter: Twitter
+      settings:
+        default_tweet: "%{entity} Default Tweet: "
+        tweet_style: "%{entity} Tweet Style: "
+        tweet_time: "%{entity} Tweet Time: "
+        tweet_time_info: "Time to tweet when style is \"Automatic at a specific time\" (format example: 3:30 pm)"
+        twitter_consumer_key: "Twitter Consumer Key: "
+        twitter_consumer_secret: "Twitter Consumer Secret: "
+        twitter_handle: "Twitter Handle: "
+        twitter_oauth_token: "Twitter Oauth Token: "
+        twitter_oauth_token_secret: "Twitter Oauth Token Secret: "
+  tweet:
+    style:
+      automatic: Automatic after posted
+      automatic_timed: Automatic at a specific time
+      disabled: Disabled
+      manual: Manual only

data/db/migrate/20120501083235_create_tweets.rb

@@ -0,0 +1,14 @@
+class CreateTweets < ActiveRecord::Migration
+  def change
+    create_table :tweets do |t|
+      t.integer :entity_id, :null => false
+      t.string :entity_type, :null => false
+      t.string :tweet, :null => false, :length => 140
+      t.datetime :tweeted_at
+      t.timestamps
+    end
+
+    add_index :tweets, :tweeted_at
+    add_index :tweets, [:entity_id, :entity_type], :unique => true
+  end
+end

data/lib/cartoonist-twitter/engine.rb

@@ -0,0 +1,67 @@
+module CartoonistTwitter
+  class EntityHooks
+    class << self
+      def after_entity_save(entity)
+        return if Setting[:"#{entity.entity_type}_tweet_style"] == :disabled
+        result = Tweet.find_for entity
+        Tweet.create_for entity unless result
+      end
+
+      def edit_entity_before_partial
+        "admin/tweets/entity_tweet"
+      end
+    end
+  end
+
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      twitter_auth_changed = lambda do
+        Twitter.configure do |twitter_config|
+          twitter_config.consumer_key = Setting[:twitter_consumer_key]
+          twitter_config.consumer_secret = Setting[:twitter_consumer_secret]
+          twitter_config.oauth_token = Setting[:twitter_oauth_token]
+          twitter_config.oauth_token_secret = Setting[:twitter_oauth_token_secret]
+        end
+      end
+
+      Setting::Section.define :twitter, :order => 2, :tab => :social_and_analytics do
+        order = 0
+
+        Cartoonist::Entity.all.each do |entity|
+          Setting.define :"#{entity.entity_type}_tweet_style", :type => :symbol, :order => (order += 1), :label => lambda { I18n.t("settings.show.settings.tweet_style", :entity => entity.entity_localized_label) }, :select_from => lambda { Tweet.styles(entity.entity_type) }, :default => :disabled
+          Setting.define :"#{entity.entity_type}_tweet_time", :order => (order += 1), :label => lambda { I18n.t("settings.show.settings.tweet_time", :entity => entity.entity_localized_label) }, :info_label => "settings.show.settings.tweet_time_info", :validation => lambda { |value| raise Setting::InvalidError.new I18n.t("settings.show.errors.invalid_tweet_time", :value => value) unless value =~ /^((1[0-2]|[1-9])\:[0-5]\d (am|pm|AM|PM))?$/ }
+          Setting.define :"#{entity.entity_type}_default_tweet", :order => (order += 1), :label => lambda { I18n.t("settings.show.settings.default_tweet", :entity => entity.entity_localized_label) }
+        end
+
+        Setting.define :twitter_handle, :order => (order += 1)
+        Setting.define :twitter_consumer_key, :onchange => twitter_auth_changed, :order => (order += 1)
+        Setting.define :twitter_consumer_secret, :onchange => twitter_auth_changed, :order => (order += 1)
+        Setting.define :twitter_oauth_token, :onchange => twitter_auth_changed, :order => (order += 1)
+        Setting.define :twitter_oauth_token_secret, :onchange => twitter_auth_changed, :order => (order += 1)
+      end
+
+      twitter_auth_changed.call
+    end
+
+    Cartoonist::Admin::Tab.add :tweets, :url => "/admin/tweets"
+    Cartoonist::Navigation::Link.add :url => (lambda { "https://twitter.com/#{Setting[:twitter_handle]}" }), :class => "follow-us", :label => "cartoonist.layout.navigation.follow_on_twitter", :title => "cartoonist.layout.navigation.follow_on_twitter_title", :order => 2
+    Cartoonist::Migration.add_for self
+    Cartoonist::Entity.register_hooks CartoonistTwitter::EntityHooks
+
+    Cartoonist::Backup.for :tweets do
+      Tweet.order(:id).all
+    end
+
+    Cartoonist::Cron.add do
+      Tweet.untweeted.each do |tweet|
+        tweet.auto_tweet!
+      end
+    end
+
+    Cartoonist::Routes.add do
+      namespace :admin do
+        resources :tweets
+      end
+    end
+  end
+end

data/lib/cartoonist-twitter.rb

@@ -0,0 +1,5 @@
+require "twitter"
+
+module CartoonistTwitter
+  require "cartoonist-twitter/engine"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: cartoonist-twitter
+version: !ruby/object:Gem::Version
+  version: 0.0.9
+  prerelease: 
+platform: ruby
+authors:
+- Mike Virata-Stone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cartoonist
+  requirement: &17879120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: *17879120
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: &17878040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *17878040
+description: Plugin to allow tweeting of cartoonist entities.
+email: reasonnumber@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- app/controllers/admin/tweets_controller.rb
+- app/models/tweet.rb
+- app/views/admin/tweets/_entity_tweet.html.erb
+- app/views/admin/tweets/edit.html.erb
+- app/views/admin/tweets/index.html.erb
+- app/views/layouts/admin/tweets.html.erb
+- cartoonist-twitter.gemspec
+- config/locales/en.yml
+- db/migrate/20120501083235_create_tweets.rb
+- lib/cartoonist-twitter.rb
+- lib/cartoonist-twitter/engine.rb
+homepage: http://reasonnumber.com/cartoonist
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Cartoonist Twitter
+test_files: []