intercom-app 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 541e991a6005427520f56e9741811f52aa2b688d
-  data.tar.gz: b502df6cd06f6a84e4aa96140c9a650572b46a49
+  metadata.gz: b1efe773248ef9439365870c93fc8eeb6157004f
+  data.tar.gz: e3ded3e1132f4cbca3bf40c086f78fea84ccce7a
 SHA512:
-  metadata.gz: f85055599e217b4a126118b482a274f2eb481fc3456472d877238eaa7d288bf556e15c59cb0dd8d0db2a7cc654cb138d6a24fcd8bd32b8a12b0f9d544a3d2699
-  data.tar.gz: 27a7271d8f82cb1afa07cc510b9b1560a385706c4048c4d2f5e8ee650de475663cd5a31ced455722d2300ace75f50192b924c6efa98d8be742b09e2d4e60091c
+  metadata.gz: 61d69c7a3937c84d1f1647865eb1534e60eba03a64aedc40a6e678a4cafac329c582e2871f6acbc0fee0b129fd3271e2c6cbb73e220ba3d2b22d745c343e85d1
+  data.tar.gz: d46307ce2dfa7d65080bf5d900a2a1ca95faed0826d1f7e947fa5514655937ad884bedf91d9a90db23d2a5cb3c12ed8355f26358af669c078bd7e473d4695d73

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,12 @@
+Please use the following template to submit your issue. Following this template will allow us to quickly investigate and help you with your issue. Please be aware that issues which do not conform to this template may be closed.
+
+## Expected behavior
+
+## Actual behavior
+
+## Steps to reproduce
+ 1.
+ 2.
+ 3.
+
+## Logs

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+test/intercom_ruby_app_example/log
+test/generators/tmp
+test/tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,148 @@
+PATH
+  remote: .
+  specs:
+    intercom-app (0.1.0)
+      intercom (~> 3.5)
+      omniauth-intercom (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.6)
+      actionview (= 4.2.6)
+      activesupport (= 4.2.6)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activejob (4.2.6)
+      activesupport (= 4.2.6)
+      globalid (>= 0.3.0)
+    activemodel (4.2.6)
+      activesupport (= 4.2.6)
+      builder (~> 3.1)
+    activerecord (4.2.6)
+      activemodel (= 4.2.6)
+      activesupport (= 4.2.6)
+      arel (~> 6.0)
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.3)
+    builder (3.2.2)
+    byebug (9.0.5)
+    concurrent-ruby (1.0.2)
+    erubis (2.7.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    globalid (0.3.6)
+      activesupport (>= 4.1.0)
+    hashie (3.4.4)
+    i18n (0.7.0)
+    intercom (3.5.1)
+      json (~> 1.8)
+    json (1.8.3)
+    jwt (1.5.4)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    metaclass (0.0.4)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    oauth2 (1.2.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.3.1)
+      hashie (>= 1.2, < 4)
+      rack (>= 1.0, < 3)
+    omniauth-intercom (0.1.2)
+      omniauth-oauth2 (~> 1.2)
+    omniauth-oauth2 (1.4.0)
+      oauth2 (~> 1.0)
+      omniauth (~> 1.2)
+    pkg-config (1.1.7)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.6)
+      actionmailer (= 4.2.6)
+      actionpack (= 4.2.6)
+      actionview (= 4.2.6)
+      activejob (= 4.2.6)
+      activemodel (= 4.2.6)
+      activerecord (= 4.2.6)
+      activesupport (= 4.2.6)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.6)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.6)
+      actionpack (= 4.2.6)
+      activesupport (= 4.2.6)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    sprockets (3.6.3)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.1.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.11)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.12)
+  byebug
+  intercom-app!
+  mocha
+  rails (~> 4.2.6)
+  rake (~> 10.0)
+  sqlite3
+
+BUNDLED WITH
+   1.12.5

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Intercom 
+
+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/README.md

@@ -0,0 +1,109 @@
+Intercom App
+===========
+
+Intercom Application Rails engine and generator
+
+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.
+
+Apply to become an Intercom Developer
+--------------------------------
+To create an Intercom application and get your `app_key` and `app_secret` you will need to create an [Intercom application](https://app.intercom.io) first.
+Once your application is created you can apply for an oauth application in the "App Settings >> Oauth" section.
+
+Installation
+------------
+To get started create a new rails app :
+
+``` sh
+# Create a new rails app
+$ rails new my_intercom_app
+$ cd my_intercom_app
+```
+Then add `intercom-app` to your Gemfile and bundle install :
+`gem 'intercom-app'`
+and run :
+``` sh
+$ bundle install
+```
+
+Now we are ready to run any of the intercom_app generators. The following section explains the generators and what they can do.
+
+
+Generators
+----------
+
+### Default Generator
+
+The default generator will run the `install`, `app_model`, and `home_controller` generators. This is the recommended way to start your app.
+
+```sh
+$ rails generate intercom_app --app_key <your_app_key> --app_secret <your_app_secret> --oauth_modal true
+```
+ **oauth_modal**:
+   - If true you can authenticate with Intercom using a modal
+   - If false you can authenticate with Intercom directly from the current tab
+
+
+### Install Generator
+
+```sh
+$ rails generate intercom_app:install
+
+# or optionally with arguments:
+
+$ rails generate intercom_app:install --app_key <your_app_key> --secret <your_app_secret> --oauth_modal true
+```
+
+You can update any of these settings later on easily, the arguments are simply for convenience.
+
+The generator adds IntercomApp and the required initializers to the host Rails application.
+
+After running the `install` generator, you can start your app with `bundle exec rails server` and install your app by visiting localhost.
+
+
+### App Model Generator
+
+```sh
+$ rails generate intercom_app:app_model
+```
+
+The install generator doesn't create any database models for you and if you are starting a new app its quite likely that you will want one (most of our internally developed apps do!). This generator creates a simple app model and a migration. It also creates a model called `SessionStorage` which interacts with `IntercomApp::SessionRepository`. Check out the later section to learn more about `IntercomApp::SessionRepository`
+
+*Note that you will need to run rake db:migrate after this generator*
+
+
+### Home Controller Generator
+
+```sh
+$ rails generate intercom_app:home_controller
+```
+
+This generator creates an example home controller that is retrieving your user list and displays your users names.
+
+
+### Controllers, Routes and Views
+
+The last group of generators are for your convenience if you want to start overriding code included as part of the Rails engine. For example by default the engine provides a simple SessionController, if you run the `rails generate intercom_app:controllers` generator then this code gets copied out into your app so you can start adding to it. Routes and views follow the exact same pattern.
+
+
+Managing App Keys and Secrets
+-----------------
+
+The `install` generator places your App credentials directly into the intercom_app initializer which is convenient and fine for development but once your app goes into production **your api credentials should not be in source control**. When we develop apps we keep our keys in environment variables so a production intercom_app initializer would look like this:
+
+```ruby
+IntercomApp.configure do |config|
+  config.api_key = ENV['INTERCOM_CLIENT_APP_KEY']
+  config.secret = ENV['INTERCOM_CLIENT_APP_SECRET']
+  config.oauth_modal = false
+end
+```
+
+Connect to the Intercom API
+----------------------
+This gem includes the following libraries :
+
+http://github.com/intercom/omniauth-intercom <= Simple rake middleware to authenticate your customers with Intercom
+http://github.com/intercom/intercom-ruby <= Intercom Ruby API wrapper

data/RELEASING

@@ -0,0 +1,14 @@
+To release a new version of the intercom-ruby-app gem :
+1. Update the version number in `intercom-ruby-app/lib/intercom-ruby-app.rb`
+2. Add a CHANGELOG entry
+3. Commit to master with an explicit message : "Bump to vX.Y.Z"
+4. Tag the new release :
+  $ git tag VX.Y.Z
+5. Push the new release :
+  $ git push
+6. Push the new tag :
+  $ git push --tags
+7. Build the new gem :
+  $ gem build intercom-ruby-app.gemspec
+8. Push the new gem :
+  $ gem push intercom-ruby-app-X.Y.Z.gem

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+require File.expand_path('../test/intercom_ruby_app_example/config/application', __FILE__)
+
+Rails.application.load_tasks

data/app/controllers/intercom_app/authenticated_controller.rb

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

data/app/controllers/intercom_app/sessions_controller.rb

@@ -0,0 +1,5 @@
+module IntercomApp
+  class SessionsController < ApplicationController
+    include IntercomApp::SessionsConcern
+  end
+end

data/app/models/intercom-app/app.rb

@@ -0,0 +1,6 @@
+module IntercomApp
+  class App < ActiveResource::Base
+    include IntercomApp::App
+    include IntercomApp::SessionStorage
+  end
+end

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

@@ -0,0 +1,15 @@
+<html>
+  <head>
+    <title>Authorized</title>
+  </head>
+  <body>
+    <script type="text/javascript">
+      setTimeout(function() {
+        if (window.opener) {
+          window.opener.oauth_success = true;
+        }
+        window.close();
+      }, 1000);
+    </script>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,7 @@
+IntercomApp::Engine.routes.draw do
+  controller :sessions do
+    get 'login' => :login, :as => :login
+    get 'auth/intercom/callback' => :callback
+    get 'logout' => :destroy, :as => :logout
+  end
+end

data/intercom-app.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'intercom-app/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'intercom-app'
+  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.authors     = ["Kevin Antoine"]
+  s.email       = 'kevin.antoine@intercom.io'
+  s.files       = ["lib/intercom-app.rb"]
+  s.homepage    =
+    'http://rubygems.org/gems/intercom-ruby-app'
+  s.license       = 'MIT'
+  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.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 'bundler', '~> 1.12'
+  s.add_development_dependency 'rake', '~> 10.0'
+end

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

@@ -0,0 +1,41 @@
+require 'rails/generators'
+
+module IntercomApp
+  module Generators
+    class AppModelGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_app_model
+        copy_file 'app.rb', 'app/models/app.rb'
+      end
+
+      def create_app_migration
+        copy_migration 'create_apps.rb'
+      end
+
+      def create_session_storage_initializer
+        copy_file 'intercom_session_repository.rb', 'config/initializers/intercom_session_repository.rb', force: true
+      end
+
+      def create_app_fixtures
+        copy_file 'apps.yml', 'test/fixtures/apps.yml'
+      end
+
+      private
+
+      def copy_migration(migration_name, config = {})
+        migration_template(
+          "db/migrate/#{migration_name}",
+          "db/migrate/#{migration_name}",
+          config
+        )
+      end
+
+      # for generating a timestamp when using `create_migration`
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+    end
+  end
+end

data/lib/generators/intercom_app/app_model/templates/app.rb

@@ -0,0 +1,4 @@
+class App < ActiveRecord::Base
+  include IntercomApp::App
+  include IntercomApp::SessionStorage
+end

data/lib/generators/intercom_app/app_model/templates/apps.yml

@@ -0,0 +1,3 @@
+example_app:
+  intercom_app_id: '123abc'
+  intercom_token: 'token'

data/lib/generators/intercom_app/app_model/templates/db/migrate/create_apps.rb

@@ -0,0 +1,15 @@
+class CreateApps < ActiveRecord::Migration
+  def self.up
+    create_table :apps  do |t|
+      t.string :intercom_app_id, null: false
+      t.string :intercom_token, null: false
+      t.timestamps
+    end
+
+    add_index :apps, :intercom_app_id, unique: true
+  end
+
+  def self.down
+    drop_table :apps
+  end
+end

data/lib/generators/intercom_app/app_model/templates/intercom_session_repository.rb

@@ -0,0 +1,7 @@
+if Rails.configuration.cache_classes
+  IntercomApp::SessionRepository.storage = App
+else
+  ActionDispatch::Reloader.to_prepare do
+    IntercomApp::SessionRepository.storage = App
+  end
+end

data/lib/generators/intercom_app/controllers/controllers_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/base'
+
+module IntercomApp
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../..", __FILE__)
+
+      def create_controllers
+        controllers.each do |controller|
+          copy_file controller
+        end
+      end
+
+      private
+
+      def controllers
+        files_within_root('.', 'app/controllers/intercom_app/*.*')
+      end
+
+      def files_within_root(prefix, glob)
+        root = "#{self.class.source_root}/#{prefix}"
+
+        Dir["#{root}/#{glob}"].sort.map do |full_path|
+          full_path.sub(root, '.').gsub('/./', '/')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'rails/generators/base'
+
+module IntercomApp
+  module Generators
+    class HomeControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_home_controller
+        template 'home_controller.rb', 'app/controllers/home_controller.rb'
+      end
+
+      def create_home_index_view
+        copy_file 'index.html.erb', 'app/views/home/index.html.erb'
+      end
+
+      def add_home_index_route
+        route "root :to => 'home#index'"
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+class HomeController < ApplicationController
+  def index
+    @users_count = @intercom_client.users.all.count()
+    @users_names = @intercom_client.users.all.map(&:name)
+  end
+end

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

@@ -0,0 +1,28 @@
+<% 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 %>
+
+<h1>Intercom application</h1>
+<h2>List your <%= @users_count %> Intercom Users names :</h2>
+<ul>
+<% @users_names.each do | name | %>
+     <li> <%= name %></li>
+<% end %>
+</ul>

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

@@ -0,0 +1,53 @@
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+
+module IntercomApp
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      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
+
+      def create_intercom_app_initializer
+        @app_key = options['app_key']
+        @app_secret = options['app_secret']
+        @oauth_modal = options['oauth_modal']
+
+        template 'intercom_app.rb', 'config/initializers/intercom_app.rb'
+      end
+
+      def create_and_inject_into_omniauth_initializer
+        unless File.exist? "config/initializers/omniauth.rb"
+          copy_file 'omniauth.rb', 'config/initializers/omniauth.rb'
+        end
+
+        inject_into_file(
+          'config/initializers/omniauth.rb',
+          File.read(File.expand_path(find_in_source_paths('intercom_provider.rb'))),
+          after: "Rails.application.config.middleware.use OmniAuth::Builder do\n"
+        )
+      end
+
+      def create_intercom_session_repository_initializer
+        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
+
+    end
+  end
+end

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

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

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

@@ -0,0 +1,3 @@
+provider :intercom,
+   IntercomApp.configuration.app_key,
+   IntercomApp.configuration.app_secret

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

@@ -0,0 +1 @@
+IntercomApp::SessionRepository.storage = InMemorySessionStore

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

@@ -0,0 +1,2 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+end

data/lib/generators/intercom_app/intercom_app_generator.rb

@@ -0,0 +1,16 @@
+module IntercomApp
+  module Generators
+    class IntercomAppGenerator < Rails::Generators::Base
+      def initialize(args, *options)
+        @opts = options.first
+        super(args, *options)
+      end
+
+      def run_all_generators
+        generate "intercom_app:install #{@opts.join(' ')}"
+        generate "intercom_app:app_model"
+        generate "intercom_app:home_controller"
+      end
+    end
+  end
+end

data/lib/intercom-app/app.rb

@@ -0,0 +1,10 @@
+module IntercomApp
+  module App
+    extend ActiveSupport::Concern
+
+    included do
+      validates :intercom_app_id, presence: true, uniqueness: true
+      validates :intercom_token, presence: true
+    end
+  end
+end

data/lib/intercom-app/configuration.rb

@@ -0,0 +1,23 @@
+module IntercomApp
+  class Configuration
+
+    attr_accessor :app_key
+    attr_accessor :app_secret
+    attr_accessor :oauth_modal
+
+    def initialize
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/intercom-app/engine.rb

@@ -0,0 +1,6 @@
+module IntercomApp
+  class Engine < Rails::Engine
+    engine_name 'intercom_app'
+    isolate_namespace IntercomApp
+  end
+end

data/lib/intercom-app/in_memory_session_store.rb

@@ -0,0 +1,25 @@
+# WARNING - This really only works for development, see README for more details
+class InMemorySessionStore
+  class EnvironmentError < StandardError; end
+
+  def self.retrieve(id)
+    repo[id]
+  end
+
+  def self.store(session)
+    id = SecureRandom.uuid
+    repo[id] = session
+    id
+  end
+
+  def self.clear
+    @@repo = nil
+  end
+
+  def self.repo
+    if Rails.env.production?
+      raise EnvironmentError.new("Cannot use InMemorySessionStore in a Production environment")
+    end
+    @@repo ||= {}
+  end
+end

data/lib/intercom-app/login_protection.rb

@@ -0,0 +1,74 @@
+module IntercomApp
+  module LoginProtection
+    extend ActiveSupport::Concern
+
+    # included do
+    #   rescue_from ActiveResource::UnauthorizedAccess, :with => :close_session
+    # end
+
+    def intercom_session
+      if app_session
+        begin
+          @intercom_client = Intercom::Client.new(app_id: app_session[:token], api_key: '')
+          yield
+        end
+      else
+        redirect_to_login
+      end
+    end
+
+    def app_session
+      return unless session[:intercom]
+      @intercom_session ||= IntercomApp::SessionRepository.retrieve(session[:intercom])
+    end
+
+    protected
+
+    def redirect_to_login
+      if request.xhr?
+        head :unauthorized
+      else
+        session[:return_to] = request.fullpath if request.get?
+        redirect_to_with_fallback main_or_engine_login_url
+      end
+    end
+
+    def close_session
+      session[:intercom] = nil
+      session[:intercom_app_id] = nil
+      redirect_to_with_fallback main_or_engine_login_url
+    end
+
+    def main_or_engine_login_url(params = {})
+      main_app.login_url(params)
+    rescue NoMethodError => e
+      intercom_app.login_url(params)
+    end
+
+    def redirect_to_with_fallback(url)
+      url_json = url.to_json
+      url_json_no_quotes = url_json.gsub(/\A"|"\Z/, '')
+
+      render inline: %Q(
+        <!DOCTYPE html>
+        <html lang="en">
+          <head>
+            <meta charset="utf-8" />
+            <title>Redirecting…</title>
+            <script type="text/javascript">
+              window.location.href = #{url_json};
+            </script>
+          </head>
+          <body>
+          </body>
+        </html>
+      ), status: 302, location: url
+    end
+
+    def fullpage_redirect_to(url)
+      url_json = url.to_json
+      url_json_no_quotes = url_json.gsub(/\A"|"\Z/, '')
+      redirect_to_with_fallback url
+    end
+  end
+end

data/lib/intercom-app/session_repository.rb

@@ -0,0 +1,34 @@
+module IntercomApp
+  class SessionRepository
+    class ConfigurationError < StandardError; end
+
+    class << self
+      def storage=(storage)
+        @storage = storage
+
+        unless storage.nil? || self.storage.respond_to?(:store) && self.storage.respond_to?(:retrieve)
+          raise ArgumentError, "storage must respond to :store and :retrieve"
+        end
+      end
+
+      def retrieve(id)
+        storage.retrieve(id)
+      end
+
+      def store(session)
+        storage.store(session)
+      end
+
+      def storage
+        load_storage || raise(ConfigurationError.new("SessionRepository.storage is not configured!"))
+      end
+
+      private
+
+      def load_storage
+        return unless @storage
+        @storage.respond_to?(:safe_constantize) ? @storage.safe_constantize : @storage
+      end
+    end
+  end
+end

data/lib/intercom-app/session_storage.rb

@@ -0,0 +1,25 @@
+module IntercomApp
+  module SessionStorage
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def store(sess)
+        app = self.find_or_initialize_by(intercom_app_id: sess[:intercom_app_id])
+        app.intercom_token = sess[:token]
+        app.save!
+        app.id
+      end
+
+      def retrieve(id)
+        return unless id
+        if app = self.find_by(id: id)
+          session = {
+            id: app.id,
+            intercom_app_id: app.intercom_app_id,
+            token: app.intercom_token
+          }
+        end
+      end
+    end
+  end
+end

data/lib/intercom-app/sessions_concern.rb

@@ -0,0 +1,35 @@
+module IntercomApp
+  module SessionsConcern
+    extend ActiveSupport::Concern
+
+    def login
+      redirect_to login_url
+    end
+
+    def callback
+      if response = request.env['omniauth.auth']
+        app = {
+          token: response['credentials']['token'],
+          intercom_app_id: response['extra']['raw_info']['app']['id_code']
+        }
+        session[:intercom] = IntercomApp::SessionRepository.store(app)
+        session[:intercom_app_id] = app[:intercom_app_id]
+        redirect_to return_address unless IntercomApp.configuration.oauth_modal
+      else
+        redirect_to login_url
+      end
+    end
+
+    def destroy
+      session[:intercom] = nil
+      session[:intercom_app_id] = nil
+      redirect_to login_url
+    end
+
+    private
+    def return_address
+      session.delete(:return_to) || '/'
+    end
+
+  end
+end

data/lib/intercom-app/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom-app
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kevin Antoine
@@ -128,7 +128,48 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- RELEASING
+- Rakefile
+- app/controllers/intercom_app/authenticated_controller.rb
+- app/controllers/intercom_app/sessions_controller.rb
+- app/models/intercom-app/app.rb
+- app/views/intercom_app/sessions/callback.html.erb
+- config/routes.rb
+- intercom-app.gemspec
+- lib/generators/intercom_app/app_model/app_model_generator.rb
+- lib/generators/intercom_app/app_model/templates/app.rb
+- lib/generators/intercom_app/app_model/templates/apps.yml
+- lib/generators/intercom_app/app_model/templates/db/migrate/create_apps.rb
+- lib/generators/intercom_app/app_model/templates/intercom_session_repository.rb
+- lib/generators/intercom_app/controllers/controllers_generator.rb
+- lib/generators/intercom_app/home_controller/home_controller_generator.rb
+- lib/generators/intercom_app/home_controller/templates/home_controller.rb
+- lib/generators/intercom_app/home_controller/templates/index.html.erb
+- lib/generators/intercom_app/install/install_generator.rb
+- lib/generators/intercom_app/install/templates/intercom_app.rb
+- lib/generators/intercom_app/install/templates/intercom_provider.rb
+- lib/generators/intercom_app/install/templates/intercom_session_repository.rb
+- lib/generators/intercom_app/install/templates/omniauth.rb
+- lib/generators/intercom_app/intercom_app_generator.rb
 - lib/intercom-app.rb
+- lib/intercom-app/app.rb
+- lib/intercom-app/configuration.rb
+- lib/intercom-app/engine.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
 homepage: http://rubygems.org/gems/intercom-ruby-app
 licenses:
 - MIT
@@ -154,4 +195,3 @@ signing_key:
 specification_version: 4
 summary: Intercom.io ruby application boilerplate
 test_files: []
-has_rdoc: