salesforce-rails 1.0.0

data/app/assets/stylesheets/salesforce/fullcalendar.print.css

@@ -0,0 +1,32 @@
+/*!
+ * FullCalendar v1.6.4 Print Stylesheet
+ * Docs & License: http://arshaw.com/fullcalendar/
+ * (c) 2013 Adam Shaw
+*/
+
+/*
+ * Include this stylesheet on your page to get a more printer-friendly calendar.
+ * When including this stylesheet, use the media='print' attribute of the <link> tag.
+ * Make sure to include this stylesheet IN ADDITION to the regular fullcalendar.css.
+*/
+
+
+/* Events
+-----------------------------------------------------*/
+
+.fc-event {
+    background: #fff !important;
+    color: #000 !important;
+}
+
+/* for vertical events */
+
+.fc-event-bg {
+    display: none !important;
+}
+
+.fc-event .ui-resizable-handle {
+    display: none !important;
+}
+
+

data/lib/generators/salesforce/calendar/install/install_generator.rb

@@ -0,0 +1,50 @@
+module Salesforce
+  module Calendar
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc "This generator installs jQuery Fullcalendar"
+        source_root File.expand_path('../templates', __FILE__)
+
+        def install
+          cleanup!
+          append_asset_pipeline!
+          setup_routes
+          copy_files
+        end
+
+        protected
+
+        def cleanup!
+          # Remove old requires (if any) that included salesforce-calendar directly:
+          gsub_file("app/assets/stylesheets/application.css", %r|\s*\*=\s*salesforce-calendar\s*\n|, "")
+          gsub_file("app/assets/javascripts/application.js", %r|\s*\//=\s*salesforce-calendar\s*\n|, "")
+          gsub_file("app/assets/javascripts/application.js", %r|\s*\//=\s*jquery.browser.min\s*\n|, "")
+          gsub_file("app/assets/javascripts/application.js", %r|\s*\//=\s*jquery.browser\s*\n|, "")
+        end
+
+        def append_asset_pipeline!
+          application_css = 'app/assets/stylesheets/application.css'
+          if File.file?(application_css)
+            insert_into_file application_css, "*= require salesforce-calendar\n", :before => " *= require_self"
+          end
+
+          application_js = 'app/assets/javascripts/application.js'
+          if File.file?(application_js)
+            insert_into_file application_js, "//= require salesforce-calendar\n", :after => "//= require jquery_ujs\n"
+          end
+        end
+
+        def setup_routes
+          route "get 'calendar', :to => 'salesforce#calendar', :as => :salesforce_calendar"
+          route "get 'calendar/json-data', :to => 'salesforce#calendar_json_data', :as => :salesforce_calendar_json_data"
+        end
+
+        def copy_files
+          copy_file 'salesforce_controller.rb.erb', File.join('app/controllers', 'salesforce_controller.rb')
+          FileUtils.mkdir_p(File.join('app/views', 'salesforce'))
+          copy_file 'calendar.html.erb', File.join('app/views', 'salesforce/calendar.html.erb')
+        end
+      end
+    end
+  end
+end

data/lib/generators/salesforce/calendar/install/templates/calendar.html.erb

@@ -0,0 +1,53 @@
+<% content_for :stylesheets do %>
+  <%= stylesheet_link_tag "salesforce/fullcalendar.print", :media => "print" %>
+<% end %>
+
+<% content_for :javascripts do %>
+  <script type="text/javascript">
+    $(document).ready(function() {
+      $('#calendar').fullCalendar({
+        header: {
+          left: 'prev,next today',
+          center: 'title',
+          right: 'month,basicWeek,basicDay'
+        },
+        editable: false,
+        ignoreTimezone: false,
+        events: {
+          url: '/calendar/json-data',
+          type: 'GET',
+          cache: true
+        },
+        eventRender: function(event, element){
+          event.allDay ? $(element).find('.fc-event-title').html('<span style="font-size:0.75em;">'+event.title+'</span><br/>'+event.subject) : $(element).find('.fc-event-title').html('<span style="font-size:0.75em;">'+$.fullCalendar.formatDate(event.start, 'HH:mm')+' - '+$.fullCalendar.formatDate(event.end, 'HH:mm')+'</span><br/>'+event.subject);
+
+          $(element).qtip({
+            content: '<div class="hoverOuter"><div><table cellspacing="0" cellpadding="0" border="0"><tbody><tr><td class="pbTitle"><h2 class="mainTitle">Event Detail</h2></td><td></td></tr></tbody></table></div><div class="sub-section"><table cellspacing="0" cellpadding="0" border="0" style="width:100%;"><tbody><tr><td class="labelCol">Assigned To</td><td class="dataCol">'+event.assign_to+'</td></tr><tr><td class="labelCol">Subject</td><td class="dataCol">'+event.subject+'</td></tr><tr><td class="labelCol">Start</td><td class="dataCol">'+$.fullCalendar.formatDate(new Date(event.start_date), (event.allDay ? "dd/MM/yyyy" : "dd/MM/yyyy HH:mm"))+'</td></tr><tr><td class="labelCol">End</td><td class="dataCol">'+$.fullCalendar.formatDate(new Date(event.end_date), (event.allDay ? "dd/MM/yyyy" : "dd/MM/yyyy HH:mm"))+'</td></tr><tr><td class="labelCol last">Description</td><td class="dataCol last">'+event.description+'</td></tr></tbody></table></div></div>',
+            position: {
+              corner: {
+                target: 'topMiddle',
+                tooltip: 'bottomLeft'
+              }
+            },
+            style: {
+              width: 350,
+              padding: 5,
+              background: '#FFFFFF',
+              color: 'black',
+              textAlign: 'center',
+              border: {
+                width: 1,
+                radius: 5,
+                color: '#DDDDDD'
+              },
+              tip: 'bottomLeft',
+              name: 'light' // Inherit the rest of the attributes from the preset dark style
+            }
+          });
+        }
+      });
+    });
+  </script>
+<% end %>
+
+<div id="calendar"></div>

data/lib/generators/salesforce/calendar/install/templates/salesforce_controller.rb.erb

@@ -0,0 +1,10 @@
+class SalesforceController < ::ApplicationController
+
+  def calendar_json_data
+    events = Salesforce::Rails::API::CalendarEvent.query("StartDateTime >= #{Time.at(params[:start].to_i).strftime("%Y-%m-%dT%H:%M:%SZ")} and StartDateTime <= #{Time.at(params[:end].to_i).strftime("%Y-%m-%dT%H:%M:%SZ")}")
+
+    respond_to do |format|
+      format.json { render json: events ? events.map { |e| { :id => e.Id, :title => (e.IsAllDayEvent ? "All Day Event" : e.Subject), :allDay => e.IsAllDayEvent, :start => e.StartDateTime, :end => e.EndDateTime, :start_date => e.StartDateTime, :end_date => e.EndDateTime, :color => (e.ShowAs == "Busy" ? "#6777cc" : "#b64b32"), :backgroundColor => (e.ShowAs == "Busy" ? "#6777cc" : "#b64b32"), :subject => e.Subject, :assign_to => e.Owner.Name, :description => e.Description, :show_as => e.ShowAs } } : nil }
+    end
+  end
+end

data/lib/generators/salesforce/config/config_generator.rb

@@ -0,0 +1,12 @@
+module Salesforce
+  module Generators
+    class ConfigGenerator < ::Rails::Generators::Base
+      desc 'This generator generate a Salesforce-Rails gem configuration file at config/salesforce.yml'
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_config_file
+        copy_file 'salesforce.yml', File.join('config', 'salesforce.yml')
+      end
+    end
+  end
+end

data/lib/generators/salesforce/config/templates/salesforce.yml

@@ -0,0 +1,32 @@
+#
+# For authentication purpose needed either :username and :password
+# OR :token and :instance_url pair
+#
+development:
+  host: <your_salesforce_host>
+  client_secret: <your_salesforce_client_secret>
+  client_id: <your_salesforce_client_id>
+  username: <your_salesforce_username>
+  password: <your_salesforce_password>
+  token:  <your_salesforce_token>
+  instance_url:  <your_salesforce_instance_url>
+  debugging: true
+
+test:
+  host: <your_salesforce_host>
+  client_secret: <your_salesforce_client_secret>
+  client_id: <your_salesforce_client_id>
+  username: <your_salesforce_username>
+  password: <your_salesforce_password>
+  token:  <your_salesforce_token>
+  instance_url:  <your_salesforce_instance_url>
+  debugging: true
+
+production:
+  host: <your_salesforce_host>
+  client_secret: <your_salesforce_client_secret>
+  client_id: <your_salesforce_client_id>
+  username: <your_salesforce_username>
+  password: <your_salesforce_password>
+  token:  <your_salesforce_token>
+  instance_url:  <your_salesforce_instance_url>

data/lib/salesforce-rails.rb

@@ -0,0 +1 @@
+require 'salesforce/rails'

data/lib/salesforce/rails.rb

@@ -0,0 +1,10 @@
+require 'yaml' unless defined?(YAML)
+require 'databasedotcom'
+require 'rails'
+require 'salesforce/rails/engine' if ::Rails.version >= '3.1'
+require 'salesforce/rails/version'
+
+require 'salesforce/rails/api/client.rb'
+Dir[File.join(File.dirname(__FILE__), 'rails', 'api', '**', '*.rb').to_s].each do |file|
+  require file
+end

data/lib/salesforce/rails/api/calendar_event.rb

@@ -0,0 +1,25 @@
+module Salesforce
+  module Rails
+    module API
+      class CalendarEvent
+          include Salesforce::Rails::API::Client
+          
+          class << self
+            # Returns all calendar events.
+            #
+            #   Salesforce::Rails::API::Calendar::Event.all #=> [#<Event @Id="1", ...>, #<Event @Id="2", ...>, #<Event @Id="3", ...>, ...]
+            def all
+              client.query("SELECT Id, Subject, IsAllDayEvent, StartDateTime, EndDateTime, Description, Owner.Name, ShowAs FROM Event")
+            end
+
+            # Returns a collection of events of self that match the conditional +where_expr+, which is the WHERE part of a SOQL query.
+            #
+            #   Salesforce::Rails::API::Calendar::Event.query("Name = 'test'") #=> [#<Event @Id="1", @Name="test", ...>, #<Event @Id="2", @Name="test", ...>, #<Event @Id="3", @Name="test", ...>, ...]
+            def query(where_expr)
+              client.query("SELECT Id, Subject, IsAllDayEvent, StartDateTime, EndDateTime, Description, Owner.Name, ShowAs FROM Event WHERE #{where_expr}")
+            end
+          end
+      end
+    end
+  end
+end

data/lib/salesforce/rails/api/client.rb

@@ -0,0 +1,32 @@
+module Salesforce
+  module Rails
+    module API
+      module Client
+        module ClassMethods
+          def client
+            unless @client
+              config = YAML.load_file(File.join(::Rails.root, 'config', 'salesforce.yml'))
+              config = config.has_key?(::Rails.env) ? config[::Rails.env] : config
+              username = config["username"]
+              password = config["password"]
+              token = config["token"]
+              instance_url = config["instance_url"]
+              @client = Databasedotcom::Client.new(config)
+              username && password ? @client.authenticate(:username => username, :password => password) : @client.authenticate(:token => token, :instance_url => instance_url)
+            end
+
+            @client
+          end
+
+          def client=(client)
+            @client = client
+          end
+        end
+
+        def self.included(base)
+          base.send(:extend, ClassMethods)
+        end
+      end
+    end
+  end
+end

data/lib/salesforce/rails/engine.rb

@@ -0,0 +1,6 @@
+module Salesforce
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/salesforce/rails/version.rb

@@ -0,0 +1,5 @@
+module Salesforce
+  module Rails
+    VERSION = "1.0.0"
+  end
+end

data/salesforce-rails.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce/rails/version'
+
+rails_version = ['>= 3.1.0', '< 4.0']
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce-rails"
+  spec.version       = Salesforce::Rails::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Diganta Mandal"]
+  spec.email         = ["diganta@emerchantpay.com"]
+  spec.summary       = %q{Convenience classes to make using the salesforce calender events with Rails apps even easier.}
+  spec.description   = %q{Convenience classes to make using the salesforce calender events with Rails apps even easier.}
+  spec.homepage      = "https://github.com/dark-prince/salesforce-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_dependency "databasedotcom"
+  spec.add_dependency "railties", rails_version
+  spec.add_dependency "actionpack", rails_version
+  spec.add_dependency "thor", ">= 0.14", "< 2.0"
+  
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "rails", rails_version
+end

data/spec/fixtures/salesforce.yml

@@ -0,0 +1,20 @@
+development:
+  client_secret: client_secret
+  client_id: client_id
+  token: foo
+  instance_url: https://na9.salesforce.com
+  debugging: true
+
+test:
+  client_secret: test_client_secret
+  client_id: test_client_secret
+  username:  test_user
+  password:  test_password
+  debugging: true
+
+production:
+  client_secret: production_client_secret
+  client_id: production_client_secret
+  username:  production_user
+  password:  production_password
+  debugging: true

data/spec/lib/salesforce/rails/api/calendar_event_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe Salesforce::Rails::API::CalendarEvent do
+  class TestClass < Salesforce::Rails::API::CalendarEvent
+  end
+
+  before do
+    config = YAML.load_file(File.join(::Rails.root, 'fixtures/salesforce.yml'))
+    config = config.has_key?(::Rails.env) ? config[::Rails.env] : config
+    token = config["token"]
+    instance_url = config["instance_url"]
+    @client = Databasedotcom::Client.new(config)
+    @client.authenticate(:token => token, :instance_url => instance_url)
+    TestClass.client = @client
+  end
+
+  context ".all" do
+    it "returns all records of events as instances" do
+      expect(@client).to receive(:query).with("SELECT Id, Subject, IsAllDayEvent, StartDateTime, EndDateTime, Description, Owner.Name, ShowAs FROM Event").and_return("foo")
+      expect(TestClass.all).to eq("foo")
+    end
+  end
+
+  context ".query" do
+    it "constructs and submits a SOQL query" do
+      expect(@client).to receive(:query).with("SELECT Id, Subject, IsAllDayEvent, StartDateTime, EndDateTime, Description, Owner.Name, ShowAs FROM Event WHERE Subject = 'foo'").and_return("bar")
+      expect(TestClass.query("Subject = 'foo'")).to eq("bar")
+    end
+  end
+end

data/spec/lib/salesforce/rails/api/client_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Salesforce::Rails::API::Client do
+  class TestClass
+    include Salesforce::Rails::API::Client
+  end
+
+  context ".client" do
+    before(:each) do
+      TestClass.client = nil
+    end
+
+    describe "if the config has an entry that matches Rails.env" do
+      it "should use the related entry" do
+        config_hash = {
+          :development => { "client_id" => "development_client_id", "client_secret" => "development_client_secret", "username" => "development_user", "password" => "development_password" },
+          :test => { "client_id" => "test_client_id", "client_secret" => "test_client_secret", "username" => "test_user", "password" => "test_password" },
+          :production => { "client_id" => "production_client_id", "client_secret" => "production_client_secret", "username" => "production_user", "password" => "production_password" }
+        }
+
+        expect(YAML).to receive(:load_file).and_return(config_hash)
+        ::Rails.stub(:env).and_return(:production)
+
+        expect_any_instance_of(Databasedotcom::Client).to receive(:authenticate).with(:username => "production_user", :password => "production_password")
+        TestClass.client
+      end
+    end
+
+    describe "if the config does not have an entry that matches Rails.env" do
+      it "should use the top level config" do
+        conf_hash = { "client_id" => "client_id", "client_secret" => "client_secret", "username" => "production_user", "password" => "production_password" }
+        ::Rails.stub(:env).and_return(:production)
+        expect(YAML).to receive(:load_file).and_return(conf_hash)
+        expect_any_instance_of(Databasedotcom::Client).to receive(:authenticate).with(:username => "production_user", :password => "production_password")
+        TestClass.client
+      end
+    end
+    
+    describe "test_user" do
+      before(:each) do
+        config_hash = { "client_id" => "client_id", "client_secret" => "client_secret", "username" => "test_user", "password" => "test_password" }
+        expect(YAML).to receive(:load_file).and_return(config_hash)
+        ::Rails.stub(:env).and_return(:test)
+      end
+    
+      it "constructs and authenticates a Databasedotcom::Client" do
+        expect_any_instance_of(Databasedotcom::Client).to receive(:authenticate).with(:username => "test_user", :password => "test_password")
+        TestClass.client
+      end
+    
+      it "is memoized" do
+        expect_any_instance_of(Databasedotcom::Client).to receive(:authenticate).exactly(1).times.with(:username => "test_user", :password => "test_password")
+        TestClass.client
+        TestClass.client
+      end
+    end
+  end
+end

data/spec/rails_mocks.rb

@@ -0,0 +1,5 @@
+module ::Rails
+  def self.root
+    File.dirname(__FILE__)
+  end
+end