intercom-app 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1efe773248ef9439365870c93fc8eeb6157004f
-  data.tar.gz: e3ded3e1132f4cbca3bf40c086f78fea84ccce7a
+  metadata.gz: cc04ec408e8cc21f7622eedb75808106f46a039e
+  data.tar.gz: ee6cb8896446949c3e2fe55bd386550296f0d657
 SHA512:
-  metadata.gz: 61d69c7a3937c84d1f1647865eb1534e60eba03a64aedc40a6e678a4cafac329c582e2871f6acbc0fee0b129fd3271e2c6cbb73e220ba3d2b22d745c343e85d1
-  data.tar.gz: d46307ce2dfa7d65080bf5d900a2a1ca95faed0826d1f7e947fa5514655937ad884bedf91d9a90db23d2a5cb3c12ed8355f26358af669c078bd7e473d4695d73
+  metadata.gz: b1749b716486ddc6bf4b75cd7ea400872823da73eecd422d02538172c25111273e9efafb7d33db439e45bf062d98b736f880ff2f5eda01fdcb9360a4b95d4e06
+  data.tar.gz: 7b2b3bc6fb9af331a6f229c290608c4911bc7e33a55753c5734df473bde6249914d20bf1ae9876b7138f4fd673765d39828df3ebd508da397f06bed250d2a29c

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## 0.1.0 (2016-07-08)
+
+Features:
+
+  * Rails generator
+  * Intercom app sessions
+  * IntercomApp::App model
+  * Intercom Omniauth
+  * intercom_app initializer (@Skaelv)
+
+## 0.1.1 (2016-07-08)
+
+  * Add lib files to gemspec (@Skaelv)
+
+## 0.2.0 (2016-08-16)
+
+  * Fix test app crashes
+  * Fix webhooks subscription
+  * Webhooks verification
+  * Move LoginProtection to AuthenticatedController
+  * Create jobs for webhooks (@Skaelv)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    intercom-app (0.1.0)
+    intercom-app (0.2.0)
       intercom (~> 3.5)
       omniauth-intercom (~> 0.1)
 
@@ -54,7 +54,7 @@ GEM
       activesupport (>= 4.1.0)
     hashie (3.4.4)
     i18n (0.7.0)
-    intercom (3.5.1)
+    intercom (3.5.2)
       json (~> 1.8)
     json (1.8.3)
     jwt (1.5.4)
@@ -85,7 +85,7 @@ GEM
     omniauth (1.3.1)
       hashie (>= 1.2, < 4)
       rack (>= 1.0, < 3)
-    omniauth-intercom (0.1.2)
+    omniauth-intercom (0.1.3)
       omniauth-oauth2 (~> 1.2)
     omniauth-oauth2 (1.4.0)
       oauth2 (~> 1.0)
@@ -137,12 +137,12 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.12)
-  byebug
+  byebug (~> 9.0)
   intercom-app!
-  mocha
-  rails (~> 4.2.6)
+  mocha (~> 1.1)
+  rails (~> 4.2)
   rake (~> 10.0)
-  sqlite3
+  sqlite3 (~> 1.3)
 
 BUNDLED WITH
    1.12.5

data/README.md

@@ -3,6 +3,8 @@ Intercom App
 
 Intercom Application Rails engine and generator
 
+*Note this SDK is in beta version and still needs a lot of improvements. We advise you to use it only if you feel you can help contributing and fix issues when you find them*
+
 Description
 -----------
 This gem includes a Rails Engine and generators for writing Rails applications using the Intercom API. The Engine provides a SessionsController and all the required code for authenticating with an app via Oauth.
@@ -46,6 +48,8 @@ $ rails generate intercom_app --app_key <your_app_key> --app_secret <your_app_se
    - If false you can authenticate with Intercom directly from the current tab
 
 
+*Note that you will need to run rake db:migrate after this generator*
+
 ### Install Generator
 
 ```sh
@@ -96,11 +100,29 @@ The `install` generator places your App credentials directly into the intercom_a
 ```ruby
 IntercomApp.configure do |config|
   config.api_key = ENV['INTERCOM_CLIENT_APP_KEY']
-  config.secret = ENV['INTERCOM_CLIENT_APP_SECRET']
+  config.app_secret = ENV['INTERCOM_CLIENT_APP_SECRET']
   config.oauth_modal = false
 end
 ```
 
+Webhooks Subscriptions
+----------------------
+
+You can add your webhooks subscriptions to the `IntercomApp.config`. Subscriptions to your topics will be added on authentication callback.
+
+```ruby
+IntercomApp.configure do |config|
+  config.webhooks = [
+    {topics: ['users'], url: 'https://my-intercom-app.com/webhooks/users'},
+    {topics: ['conversation.user.created', 'conversation.user.replied'], url: 'https://my-intercom-app.com/webhooks/conversations'},
+    {topics: ['event.created'], url: 'https://my-intercom-app.com/webhooks/conversations', metadata: { event_names: events } }
+  ]
+end
+```
+
+**Important** You will need to request the `manage_webhooks` permissions from Intercom to receive webhooks from Intercom.
+
+
 Connect to the Intercom API
 ----------------------
 This gem includes the following libraries :

data/RELEASING

@@ -9,6 +9,6 @@ To release a new version of the intercom-ruby-app gem :
 6. Push the new tag :
   $ git push --tags
 7. Build the new gem :
-  $ gem build intercom-ruby-app.gemspec
+  $ gem build intercom-app.gemspec
 8. Push the new gem :
-  $ gem push intercom-ruby-app-X.Y.Z.gem
+  $ gem push intercom-app-X.Y.Z.gem

data/app/controllers/intercom_app/authenticated_controller.rb

@@ -1,6 +1,7 @@
 module IntercomApp
   class AuthenticatedController < ApplicationController
-    # before_action :login_again_if_different_app
+    include IntercomApp::LoginProtection
+
     around_action :intercom_session
     layout 'application'
   end

data/app/controllers/intercom_app/webhooks_controller.rb

@@ -0,0 +1,33 @@
+module IntercomApp
+  class WebhooksController < ApplicationController
+    skip_before_action :verify_authenticity_token
+
+    include IntercomApp::WebhookVerification
+
+    class IntercomApp::MissingWebhookJobDeclarationError < StandardError; end
+
+    def receive
+      webhook_job_klass.perform_later({app_id: app_id, webhook: webhook_params.to_h})
+      head :no_content
+    end
+
+    private
+
+    def webhook_params
+      params.except(:controller, :action, :type)
+    end
+
+    def webhook_job_klass
+      "#{webhook_type.sub('.','_').classify}Job".safe_constantize or raise IntercomApp::MissingWebhookJobDeclarationError
+    end
+
+    def webhook_type
+      params[:type]
+    end
+
+    def app_id
+      params[:app_id]
+    end
+
+  end
+end

data/app/views/intercom_app/sessions/login.html.erb

@@ -0,0 +1,23 @@
+<% if IntercomApp.configuration.oauth_modal %>
+  <a href="javascript:void(0)" class="intercom-oauth-cta">
+    <img src="https://static.intercomassets.com/assets/oauth/primary-7edb2ebce84c088063f4b86049747c3a.png" srcset="https://static.intercomassets.com/assets/oauth/primary-7edb2ebce84c088063f4b86049747c3a.png 1x, https://static.intercomassets.com/assets/oauth/primary@2x-0d69ca2141dfdfa0535634610be80994.png 2x, https://static.intercomassets.com/assets/oauth/primary@3x-788ed3c44d63a6aec3927285e920f542.png 3x"/>
+  </a>
+  <script type="text/javascript">
+  $('.intercom-oauth-cta').unbind('click').click(function() {
+      var left = (screen.width/2)-(700/2);
+      var top = (screen.height/2)-(450/2);
+      var opts = 'width=700, height=450, top='+top+', left='+left
+      var auth_window = window.open('/auth/intercom', 'Sign in', opts);
+      var checkWindow = function() {
+        if (auth_window.closed) {
+        window.location = '/';
+        } else if (window.oauth_success === undefined) {
+          setTimeout(checkWindow, 200);
+      }
+      };
+    checkWindow();
+  });
+  </script>
+<% else %>
+  <a href="/auth/intercom">Login</a>
+<% end %>

data/config/routes.rb

@@ -4,4 +4,8 @@ IntercomApp::Engine.routes.draw do
     get 'auth/intercom/callback' => :callback
     get 'logout' => :destroy, :as => :logout
   end
+
+  namespace :webhooks do
+    post ':type' => :receive
+  end
 end

data/intercom-app.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = IntercomApp::VERSION
   s.date        = '2016-07-04'
   s.summary     = "Intercom.io ruby application boilerplate"
-  s.description = "This gem helps you to get started with your Intercom.io app"
+  s.description = "This gem helps you to get started with your Intercom app"
   s.authors     = ["Kevin Antoine"]
   s.email       = 'kevin.antoine@intercom.io'
   s.files       = ["lib/intercom-app.rb"]
@@ -17,13 +17,15 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
 
-  s.add_runtime_dependency 'intercom', '~>3.5'
+  s.required_ruby_version = '>= 2.2.2'
+
+  s.add_runtime_dependency 'intercom', '~> 3.5'
   s.add_runtime_dependency 'omniauth-intercom', '~>0.1'
 
   s.add_development_dependency 'rails', '~> 4.2'
-  s.add_development_dependency 'sqlite3', '~> 0'
-  s.add_development_dependency 'mocha', '~> 0'
-  s.add_development_dependency 'byebug', '~> 0'
+  s.add_development_dependency 'sqlite3', '~> 1.3'
+  s.add_development_dependency 'mocha', '~> 1.1'
+  s.add_development_dependency 'byebug', '~> 9.0'
   s.add_development_dependency 'bundler', '~> 1.12'
   s.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/generators/intercom_app/app_model/app_model_generator.rb

@@ -34,7 +34,8 @@ module IntercomApp
 
       # for generating a timestamp when using `create_migration`
       def self.next_migration_number(dir)
-        ActiveRecord::Generators::Base.next_migration_number(dir)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+        # ActiveRecord::Migration.next_migration_number(dir)
       end
     end
   end

data/lib/generators/intercom_app/home_controller/templates/home_controller.rb

@@ -1,6 +1,6 @@
-class HomeController < ApplicationController
+class HomeController < IntercomApp::AuthenticatedController
+
   def index
-    @users_count = @intercom_client.users.all.count()
-    @users_names = @intercom_client.users.all.map(&:name)
+    @users_names = @intercom_client.users.find_all(:type=>'users', :per_page => 10, :page => 1, :order => "desc", :sort => "created_at").map(&:name)
   end
 end

data/lib/generators/intercom_app/home_controller/templates/index.html.erb

@@ -1,26 +1,6 @@
-<% if IntercomApp.configuration.oauth_modal %>
-  <a href="javascript:void(0)" class="intercom-oauth-cta">
-    <img src="https://static.intercomassets.com/assets/oauth/primary-7edb2ebce84c088063f4b86049747c3a.png" srcset="https://static.intercomassets.com/assets/oauth/primary-7edb2ebce84c088063f4b86049747c3a.png 1x, https://static.intercomassets.com/assets/oauth/primary@2x-0d69ca2141dfdfa0535634610be80994.png 2x, https://static.intercomassets.com/assets/oauth/primary@3x-788ed3c44d63a6aec3927285e920f542.png 3x"/>
-  </a>
-  <script type="text/javascript">
-  $('.intercom-oauth-cta').unbind('click').click(function() {
-      var auth_window = window.open('/auth/intercom', 'Sign in', 'width=700,height=450');
-      var checkWindow = function() {
-        if (auth_window.closed) {
-        window.location = '/';
-        } else if (window.oauth_success === undefined) {
-          setTimeout(checkWindow, 200);
-      }
-      };
-    checkWindow();
-  });
-  </script>
-<% else %>
-  <a href="/auth/intercom">Login</a>
-<% end %>
-
+<a href="/login">Login</a>
 <h1>Intercom application</h1>
-<h2>List your <%= @users_count %> Intercom Users names :</h2>
+<h2>Users list:</h2>
 <ul>
 <% @users_names.each do | name | %>
      <li> <%= name %></li>

data/lib/generators/intercom_app/install/install_generator.rb

@@ -1,20 +1,25 @@
 require 'rails/generators/base'
 require 'rails/generators/active_record'
+require 'intercom-app/hub_secret_generator'
+
 
 module IntercomApp
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
+      include IntercomApp::Utils
       source_root File.expand_path('../templates', __FILE__)
 
       class_option :app_key, type: :string, default: '<app_key>'
       class_option :app_secret, type: :string, default: '<app_secret>'
       class_option :oauth_modal, type: :boolean, default: false
+      class_option :hub_secret, type: :string
 
       def create_intercom_app_initializer
         @app_key = options['app_key']
         @app_secret = options['app_secret']
         @oauth_modal = options['oauth_modal']
+        @hub_secret = generate_hub_secret
 
         template 'intercom_app.rb', 'config/initializers/intercom_app.rb'
       end
@@ -35,19 +40,20 @@ module IntercomApp
         copy_file 'intercom_session_repository.rb', 'config/initializers/intercom_session_repository.rb'
       end
 
-
-      def inject_into_application_controller
-        inject_into_class(
-          "app/controllers/application_controller.rb",
-          'ApplicationController',
-          "  include IntercomApp::LoginProtection\n"
-        )
-      end
-
       def mount_engine
         route "mount IntercomApp::Engine, at: '/'"
       end
 
+      private
+
+      def generate_hub_secret
+        if yes?("In order to increase the safety of your app, would you like your webhooks to be automatically signed?(y/n)")
+          return random_hub_secret
+        else
+          return ''
+        end
+      end
+
     end
   end
 end

data/lib/generators/intercom_app/install/templates/intercom_app.rb

@@ -1,5 +1,6 @@
 IntercomApp.configure do |config|
   config.app_key = "<%= @app_key %>"
   config.app_secret = "<%= @app_secret %>"
+  config.hub_secret = "<%= @hub_secret %>"
   config.oauth_modal = <%= @oauth_modal %>
 end

data/lib/intercom-app.rb

@@ -2,11 +2,14 @@ require 'intercom-app/version'
 require 'intercom-app/app'
 require 'intercom-app/configuration'
 require 'intercom-app/engine'
+require 'intercom-app/hub_secret_generator'
 require 'intercom-app/in_memory_session_store'
 require 'intercom-app/login_protection'
 require 'intercom-app/session_repository'
 require 'intercom-app/session_storage'
 require 'intercom-app/sessions_concern'
+require 'intercom-app/webhook_verification'
+require 'intercom-app/webhooks_manager'
 
 # deps
 require 'intercom'

data/lib/intercom-app/configuration.rb

@@ -4,6 +4,8 @@ module IntercomApp
     attr_accessor :app_key
     attr_accessor :app_secret
     attr_accessor :oauth_modal
+    attr_accessor :webhooks
+    attr_accessor :hub_secret
 
     def initialize
     end

data/lib/intercom-app/hub_secret_generator.rb

@@ -0,0 +1,14 @@
+require 'digest/sha1'
+
+module IntercomApp
+  module Utils
+
+    def random_string
+      (0...20).map { (65 + rand(26)).chr }.join
+    end
+
+    def random_hub_secret
+      Digest::SHA1.hexdigest random_string
+    end
+  end
+end

data/lib/intercom-app/login_protection.rb

@@ -9,7 +9,7 @@ module IntercomApp
     def intercom_session
       if app_session
         begin
-          @intercom_client = Intercom::Client.new(app_id: app_session[:token], api_key: '')
+          @intercom_client = Intercom::Client.new(token: app_session[:token])
           yield
         end
       else

data/lib/intercom-app/sessions_concern.rb

@@ -2,8 +2,8 @@ module IntercomApp
   module SessionsConcern
     extend ActiveSupport::Concern
 
-    def login
-      redirect_to login_url
+    included do
+      include IntercomApp::LoginProtection
     end
 
     def callback
@@ -14,6 +14,7 @@ module IntercomApp
         }
         session[:intercom] = IntercomApp::SessionRepository.store(app)
         session[:intercom_app_id] = app[:intercom_app_id]
+        IntercomApp::WebhooksManager.new(intercom_token: app[:token]).create_webhooks if IntercomApp.configuration.webhooks.present?
         redirect_to return_address unless IntercomApp.configuration.oauth_modal
       else
         redirect_to login_url

data/lib/intercom-app/version.rb

@@ -1,3 +1,3 @@
 module IntercomApp
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/intercom-app/webhook_verification.rb

@@ -0,0 +1,26 @@
+module IntercomApp
+  module WebhookVerification
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :verify_request
+    end
+
+    private
+    def verify_request
+      body = request.body.read
+      return head :unauthorized unless hmac_valid?(body)
+    end
+
+    def hmac_valid?(payload_body)
+      secret = IntercomApp.configuration.hub_secret
+      signature = 'sha1=' + OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), secret, payload_body)
+      Rack::Utils.secure_compare(signature, intercom_hmac)
+    end
+
+    def intercom_hmac
+      request.headers['X-Hub-Signature']
+    end
+
+  end
+end

data/lib/intercom-app/webhooks_manager.rb

@@ -0,0 +1,60 @@
+module IntercomApp
+  class WebhooksManager
+    class CreationFailed < StandardError; end
+    def initialize(params)
+      @intercom_token = params[:intercom_token]
+    end
+
+    def create_webhooks_subscriptions
+      return unless required_webhooks.present?
+      required_webhooks.each do |webhook|
+        create_webhook_subscription(webhook) unless webhook_subscription_exists?(webhook[:topics])
+      end
+    end
+
+    def destroy_webhooks_subscriptions
+      intercom_client.subscriptions.all.each do |webhook|
+        intercom_client.subscriptions.delete(webhook.id) if is_required_webhook?(webhook)
+      end
+
+      @current_webhooks_subscriptions = nil
+    end
+
+    def recreate_webhooks_subscriptions!
+      destroy_webhooks_subscriptions
+      create_webhooks_subscriptions
+    end
+
+    private
+
+    def intercom_client
+      @intercom_client ||= Intercom::Client.new(app_id: @intercom_token, api_key: '')
+    end
+
+    def required_webhooks
+      IntercomApp.configuration.webhooks
+    end
+
+    def is_required_webhook?(webhook)
+      required_webhooks.map{ |w| w[:url] }.include? webhook.url
+    end
+
+    def create_webhook_subscription(attributes)
+      add_hub_secret_to_subscription(attributes)
+      webhook = intercom_client.subscriptions.create(attributes)
+    end
+
+    def webhook_subscription_exists?(topics)
+      current_webhooks_subscriptions[topics]
+    end
+
+    def current_webhooks_subscriptions
+      @current_webhooks_subscriptions ||= intercom_client.subscriptions.all.index_by(&:topics)
+    end
+
+    def add_hub_secret_to_subscription(attributes)
+      attributes[:hub_secret] = IntercomApp.configuration.hub_secret if IntercomApp.configuration.hub_secret.present?
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-app
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Antoine
@@ -58,42 +58,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '9.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: This gem helps you to get started with your Intercom.io app
+description: This gem helps you to get started with your Intercom app
 email: kevin.antoine@intercom.io
 executables: []
 extensions: []
@@ -132,7 +132,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -141,8 +141,10 @@ files:
 - Rakefile
 - app/controllers/intercom_app/authenticated_controller.rb
 - app/controllers/intercom_app/sessions_controller.rb
+- app/controllers/intercom_app/webhooks_controller.rb
 - app/models/intercom-app/app.rb
 - app/views/intercom_app/sessions/callback.html.erb
+- app/views/intercom_app/sessions/login.html.erb
 - config/routes.rb
 - intercom-app.gemspec
 - lib/generators/intercom_app/app_model/app_model_generator.rb
@@ -164,12 +166,15 @@ files:
 - lib/intercom-app/app.rb
 - lib/intercom-app/configuration.rb
 - lib/intercom-app/engine.rb
+- lib/intercom-app/hub_secret_generator.rb
 - lib/intercom-app/in_memory_session_store.rb
 - lib/intercom-app/login_protection.rb
 - lib/intercom-app/session_repository.rb
 - lib/intercom-app/session_storage.rb
 - lib/intercom-app/sessions_concern.rb
 - lib/intercom-app/version.rb
+- lib/intercom-app/webhook_verification.rb
+- lib/intercom-app/webhooks_manager.rb
 homepage: http://rubygems.org/gems/intercom-ruby-app
 licenses:
 - MIT
@@ -182,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -190,8 +195,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Intercom.io ruby application boilerplate
 test_files: []
+has_rdoc: 

data/CHANGELOG

@@ -1,7 +0,0 @@
-0.1.0
------
-* Rails generator
-* Intercom app sessions
-* IntercomApp::App model
-* Intercom Omniauth
-* intercom_app initializer